/***************************************************************************
- * Copyright (C) 2005-2015 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef AUTHENTICATOR_H
-#define AUTHENTICATOR_H
+#pragma once
-#include <QtCore>
+#include <QObject>
+#include <QProcessEnvironment>
+#include <QString>
+#include <QStringList>
+#include <QVariant>
#include "types.h"
-class Authenticator : public QObject {
-
- Q_OBJECT
-
+class Authenticator : public QObject
+{
+ Q_OBJECT
+
public:
- Authenticator(QObject *parent = 0);
- virtual ~Authenticator() {};
+ using QObject::QObject;
+ ~Authenticator() override = default;
- enum State {
- IsReady, // ready to go
- NeedsSetup, // need basic setup (ask the user for input)
- NotAvailable // remove the authenticator backend from the list of avaliable authenticators.
+ enum State
+ {
+ IsReady, // ready to go
+ NeedsSetup, // need basic setup (ask the user for input)
+ NotAvailable // remove the authenticator backend from the list of avaliable authenticators.
};
-
public slots:
- // General
-
+ // General
+
//! Check if the authenticator type is available.
/** An authenticator subclass should return true if it can be successfully used, i.e. if all
* prerequisites are in place.
*/
virtual bool isAvailable() const = 0;
+ //! Returns the identifier of the authenticator backend
+ /** \return A string that can be used by the client to identify the authenticator backend */
+ virtual QString backendId() const = 0;
+
//! Returns the display name of the authenticator backend
/** \return A string that can be used by the client to name the authenticator backend */
virtual QString displayName() const = 0;
-
+
//! Returns a description of this authenticator backend
/** \return A string that can be displayed by the client to describe the authenticator */
virtual QString description() const = 0;
- //! Returns a list of properties required to use the authenticator backend
- virtual QStringList setupKeys() const = 0;
+ //! Returns data required to configure the authenticator backend
+ /**
+ * A list of flattened triples for each field: {key, translated field name, default value}
+ * The default value's type determines the kind of input widget to be shown
+ * (int -> QSpinBox; QString -> QLineEdit)
+ * \return A list of triples defining the data to be shown in the configuration dialog
+ */
+ virtual QVariantList setupData() const = 0;
- //! Returns a map where the keys are are properties to use the authenticator backend
- /* the values are QVariants with default values */
- virtual QVariantMap setupDefaults() const = 0;
+ //! Checks if the authenticator allows manual password changes from inside quassel.
+ virtual bool canChangePassword() const = 0;
//! Setup the authenticator provider.
/** This prepares the authenticator provider (e.g. create tables, etc.) for use within Quassel.
* \param settings Hostname, port, username, password, ...
* \return True if and only if the authenticator provider was initialized successfully.
*/
- virtual bool setup(const QVariantMap &settings = QVariantMap()) = 0;
+ virtual bool setup(const QVariantMap& settings = QVariantMap(),
+ const QProcessEnvironment& environment = {},
+ bool loadFromEnvironment = false)
+ = 0;
//! Initialize the authenticator provider
/** \param settings Hostname, port, username, password, ...
* \return the State the authenticator backend is now in (see authenticator::State)
*/
- virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
+ virtual State init(const QVariantMap& settings = QVariantMap(),
+ const QProcessEnvironment& environment = {},
+ bool loadFromEnvironment = false)
+ = 0;
//! Validate a username with a given password.
/** \param user The username to validate
* \param password The user's alleged password
* \return A valid UserId if the password matches the username; 0 else
*/
- virtual UserId validateUser(const QString &user, const QString &password) = 0;
-
-private:
-
+ virtual UserId validateUser(const QString& user, const QString& password) = 0;
};
-
-#endif
\ No newline at end of file