Skip to content

Commit

Permalink
Refactor DatabaseOpenWidget/Dialog and Auto-Type Database unlocking.
Browse files Browse the repository at this point in the history
This patch removes redundant lock widget members of the DatabaseWidget
and consolidates all unlocking functionality into a single
DatabaseOpenWidget (with the exception of KeePass1OpenWidget).
Distinction between different unlock actions is now done via a dedicated
Intent enum class instead of using individual widgets.

Further, the DatabaseUnlockDialog has been generalized so that it is
usable for unlock intents other than just Auto-Type and is now also
used for merging databases which is less confusing to the user.

The KeePassXC main window is no longer a parent of the
DatabaseUnlockDialog and has the Qt::ForeignWindow flag set, which
should cause fewer issues with Auto-Type trying to type into KeePassXC
after unlock instead of the intended target window.

In addition, its instance has been moved into the DatabaseTabWidget
class so that it is no longer bound to individual DatabaseWidgets,
potentially allowing for database selection during Auto-Type. The actual
selection has not yet been implemented, but Auto-Type has been adjusted
to use the currently selected tab instead of the first one as an
intermediary improvement.
  • Loading branch information
phoerious committed Nov 24, 2018
1 parent ff7191e commit 3c362ac
Show file tree
Hide file tree
Showing 13 changed files with 290 additions and 294 deletions.
3 changes: 1 addition & 2 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,7 @@ set(keepassx_SOURCES
gui/TotpSetupDialog.cpp
gui/TotpDialog.cpp
gui/TotpExportSettingsDialog.cpp
gui/UnlockDatabaseWidget.cpp
gui/UnlockDatabaseDialog.cpp
gui/DatabaseOpenDialog.cpp
gui/WelcomeWidget.cpp
gui/csvImport/CsvImportWidget.cpp
gui/csvImport/CsvImportWizard.cpp
Expand Down
89 changes: 89 additions & 0 deletions src/gui/DatabaseOpenDialog.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
/*
* Copyright (C) 2018 KeePassXC Team <[email protected]>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 or (at your option)
* version 3 of the License.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/

#include "DatabaseOpenDialog.h"
#include "DatabaseOpenWidget.h"
#include "DatabaseWidget.h"
#include "core/Database.h"

DatabaseOpenDialog::DatabaseOpenDialog(QWidget* parent)
: QDialog(parent)
, m_view(new DatabaseOpenWidget(this))
{
setWindowTitle(tr("Unlock Database - KeePassXC"));
setWindowFlags(windowFlags() | Qt::WindowStaysOnTopHint | Qt::ForeignWindow);
connect(m_view, SIGNAL(dialogFinished(bool)), this, SLOT(complete(bool)));
}

void DatabaseOpenDialog::setFilePath(const QString& filePath)
{
m_view->load(filePath);
}

/**
* Set target DatabaseWidget to which signals are connected.
*
* @param dbWidget database widget
*/
void DatabaseOpenDialog::setTargetDatabaseWidget(DatabaseWidget* dbWidget)
{
if (m_dbWidget) {
disconnect(this, nullptr, m_dbWidget, nullptr);
}
m_dbWidget = dbWidget;
connect(this, SIGNAL(dialogFinished(bool)), dbWidget, SLOT(unlockDatabase(bool)));
}

void DatabaseOpenDialog::setIntent(DatabaseOpenDialog::Intent intent)
{
m_intent = intent;
}

DatabaseOpenDialog::Intent DatabaseOpenDialog::intent() const
{
return m_intent;
}

void DatabaseOpenDialog::clearForms()
{
m_view->clearForms();
m_db.reset();
m_intent = Intent::None;
if (m_dbWidget) {
disconnect(this, nullptr, m_dbWidget, nullptr);
m_dbWidget = nullptr;
}
}

QSharedPointer<Database> DatabaseOpenDialog::database()
{
return m_db;
}

void DatabaseOpenDialog::complete(bool accepted)
{
// save DB, since DatabaseOpenWidget will reset its data after accept() is called
m_db = m_view->database();

if (accepted) {
accept();
} else {
reject();
}
emit dialogFinished(accepted);
clearForms();
}
39 changes: 27 additions & 12 deletions src/gui/UnlockDatabaseDialog.h → src/gui/DatabaseOpenDialog.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2016 KeePassXC Team <[email protected]>
* Copyright (C) 2018 KeePassXC Team <[email protected]>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand All @@ -18,32 +18,47 @@
#ifndef KEEPASSX_AUTOTYPEUNLOCKDIALOG_H
#define KEEPASSX_AUTOTYPEUNLOCKDIALOG_H

#include <QDialog>

//#include <gui/DatabaseTabWidget.h>

#include "core/Global.h"

class UnlockDatabaseWidget;
#include <QDialog>
#include <QPointer>
#include <QSharedPointer>

class Database;
class DatabaseWidget;
class DatabaseOpenWidget;

class UnlockDatabaseDialog : public QDialog
class DatabaseOpenDialog : public QDialog
{
Q_OBJECT

public:
explicit UnlockDatabaseDialog(QWidget* parent = nullptr);
enum class Intent
{
None,
AutoType,
Merge
};

explicit DatabaseOpenDialog(QWidget* parent = nullptr);
void setFilePath(const QString& filePath);
void clearForms();
void setTargetDatabaseWidget(DatabaseWidget* dbWidget);
void setIntent(Intent intent);
Intent intent() const;
QSharedPointer<Database> database();
void clearForms();

signals:
void unlockDone(bool);
void dialogFinished(bool);

public slots:
void complete(bool r);
void complete(bool accepted);

private:
UnlockDatabaseWidget* const m_view;
QPointer<DatabaseOpenWidget> m_view;
QSharedPointer<Database> m_db;
QPointer<DatabaseWidget> m_dbWidget;
Intent m_intent = Intent::None;
};

#endif // KEEPASSX_AUTOTYPEUNLOCKDIALOG_H
66 changes: 54 additions & 12 deletions src/gui/DatabaseTabWidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,24 @@
#include "core/Global.h"
#include "core/Group.h"
#include "core/Metadata.h"
#include "core/Tools.h"
#include "format/CsvExporter.h"
#include "gui/Clipboard.h"
#include "gui/DatabaseWidget.h"
#include "gui/DatabaseWidgetStateSync.h"
#include "gui/DragTabBar.h"
#include "gui/FileDialog.h"
#include "gui/MessageBox.h"
#include "gui/UnlockDatabaseDialog.h"
#include "gui/DatabaseOpenDialog.h"
#include "gui/entry/EntryView.h"
#include "gui/group/GroupView.h"
#include "gui/wizard/NewDatabaseWizard.h"

DatabaseTabWidget::DatabaseTabWidget(QWidget* parent)
: QTabWidget(parent)
, m_dbWidgetStateSync(new DatabaseWidgetStateSync(this))
, m_dbPendingLock(nullptr)
, m_dbWidgetPendingLock(nullptr)
, m_databaseOpenDialog(new DatabaseOpenDialog())
{
auto* tabBar = new DragTabBar(this);
setTabBar(tabBar);
Expand All @@ -54,6 +56,7 @@ DatabaseTabWidget::DatabaseTabWidget(QWidget* parent)
connect(this, SIGNAL(activateDatabaseChanged(DatabaseWidget*)), m_dbWidgetStateSync, SLOT(setActive(DatabaseWidget*)));
connect(autoType(), SIGNAL(globalShortcutTriggered()), SLOT(performGlobalAutoType()));
connect(autoType(), SIGNAL(autotypePerformed()), SLOT(relockPendingDatabase()));
connect(autoType(), SIGNAL(autotypeRejected()), SLOT(relockPendingDatabase()));
}

DatabaseTabWidget::~DatabaseTabWidget()
Expand Down Expand Up @@ -220,9 +223,9 @@ void DatabaseTabWidget::mergeDatabase()
}
}

void DatabaseTabWidget::mergeDatabase(const QString& fileName)
void DatabaseTabWidget::mergeDatabase(const QString& filePath)
{
currentDatabaseWidget()->switchToOpenMergeDatabase(fileName);
unlockDatabaseInDialog(currentDatabaseWidget(), DatabaseOpenDialog::Intent::Merge, filePath);
}

void DatabaseTabWidget::importKeePass1Database()
Expand Down Expand Up @@ -513,23 +516,60 @@ void DatabaseTabWidget::lockDatabases()
}
}

/**
* Unlock a database with an unlock popup dialog.
*
* @param dbWidget DatabaseWidget which to connect signals to
* @param intent intent for unlocking
*/
void DatabaseTabWidget::unlockDatabaseInDialog(DatabaseWidget* dbWidget, DatabaseOpenDialog::Intent intent)
{
unlockDatabaseInDialog(dbWidget, intent, dbWidget->database()->filePath());
}

/**
* Unlock a database with an unlock popup dialog.
*
* @param dbWidget DatabaseWidget which to connect signals to
* @param intent intent for unlocking
* @param file path of the database to be unlocked
*/
void DatabaseTabWidget::unlockDatabaseInDialog(DatabaseWidget* dbWidget, DatabaseOpenDialog::Intent intent,
const QString& filePath)
{
m_databaseOpenDialog->setTargetDatabaseWidget(dbWidget);
m_databaseOpenDialog->setIntent(intent);
m_databaseOpenDialog->setFilePath(filePath);

#ifdef Q_OS_MACOS
if (intent == DatabaseOpenDialog::Intent::AutoType) {
autoType()->raiseWindow();
Tools::wait(500);
}
#endif

m_databaseOpenDialog->show();
m_databaseOpenDialog->raise();
m_databaseOpenDialog->activateWindow();
}

/**
* This function relock the pending database when autotype has been performed successfully
* A database is marked as pending when it's unlocked after a global Auto-Type invocation
*/
void DatabaseTabWidget::relockPendingDatabase()
{
if (!m_dbPendingLock || !config()->get("security/relockautotype").toBool()) {
if (!m_dbWidgetPendingLock || !config()->get("security/relockautotype").toBool()) {
return;
}

if (m_dbPendingLock->isLocked() || !m_dbPendingLock->database()->hasKey()) {
m_dbPendingLock = nullptr;
if (m_dbWidgetPendingLock->isLocked() || !m_dbWidgetPendingLock->database()->hasKey()) {
m_dbWidgetPendingLock = nullptr;
return;
}

m_dbPendingLock->lock();
m_dbPendingLock = nullptr;
m_dbWidgetPendingLock->lock();
m_dbWidgetPendingLock = nullptr;
}

void DatabaseTabWidget::updateLastDatabases(const QString& filename)
Expand Down Expand Up @@ -579,11 +619,13 @@ void DatabaseTabWidget::performGlobalAutoType()
}
}

// TODO: allow for database selection during Auto-Type instead of using the current tab
if (!unlockedDatabases.isEmpty()) {
autoType()->performGlobalAutoType(unlockedDatabases);
} else if (count() > 0) {
// TODO: allow for database selection during Auto-Type instead of using the first tab
m_dbPendingLock = databaseWidgetFromIndex(0);
m_dbPendingLock->prepareUnlock();
if (config()->get("security/relockautotype").toBool()) {
m_dbWidgetPendingLock = currentDatabaseWidget();
}
unlockDatabaseInDialog(currentDatabaseWidget(), DatabaseOpenDialog::Intent::AutoType);
}
}
7 changes: 5 additions & 2 deletions src/gui/DatabaseTabWidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#define KEEPASSX_DATABASETABWIDGET_H

#include "gui/MessageWidget.h"
#include "DatabaseOpenDialog.h"

#include <QTabWidget>
#include <QPointer>
Expand All @@ -27,7 +28,6 @@ class Database;
class DatabaseWidget;
class DatabaseWidgetStateSync;
class DatabaseOpenWidget;
class QFile;

class DatabaseTabWidget : public QTabWidget
{
Expand Down Expand Up @@ -68,6 +68,8 @@ public slots:

void lockDatabases();
void closeDatabaseFromSender();
void unlockDatabaseInDialog(DatabaseWidget* dbWidget, DatabaseOpenDialog::Intent intent);
void unlockDatabaseInDialog(DatabaseWidget* dbWidget, DatabaseOpenDialog::Intent intent, const QString& filePath);
void relockPendingDatabase();

void changeMasterKey();
Expand All @@ -93,7 +95,8 @@ private slots:
void updateLastDatabases(const QString& filename);

QPointer<DatabaseWidgetStateSync> m_dbWidgetStateSync;
QPointer<DatabaseWidget> m_dbPendingLock;
QPointer<DatabaseWidget> m_dbWidgetPendingLock;
QScopedPointer<DatabaseOpenDialog> m_databaseOpenDialog;
};

#endif // KEEPASSX_DATABASETABWIDGET_H
Loading

0 comments on commit 3c362ac

Please sign in to comment.