/***************************************************************************
- * Copyright (C) 2005-2012 by the Quassel Project *
+ * Copyright (C) 2005-2018 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
Q_OBJECT
public:
- Storage(QObject *parent = 0);
- virtual ~Storage() {};
+ Storage(QObject *parent = nullptr);
enum State {
IsReady, // ready to go
NotAvailable // remove the storage backend from the list of avaliable backends
};
+ enum HashVersion {
+ Sha1,
+ Sha2_512,
+ Latest=Sha2_512
+
+ };
+
public slots:
/* General */
*/
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 storage backend
/** \return A string that can be used by the client to name the storage backend */
virtual QString displayName() const = 0;
/** \return A string that can be displayed by the client to describe the storage backend */
virtual QString description() const = 0;
- //! Returns a list of properties required to use the storage backend
- virtual QStringList setupKeys() const = 0;
-
- //! Returns a map where the keys are are properties to use the storage backend
- /* the values are QVariants with default values */
- virtual QVariantMap setupDefaults() 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;
//! Setup the storage provider.
/** This prepares the storage provider (e.g. create tables, etc.) for use within Quassel.
* \param settings Hostname, port, username, password, ...
* \return True if and only if the storage 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 storage provider
/** \param settings Hostname, port, username, password, ...
* \return the State the storage backend is now in (see Storage::State)
*/
- virtual State init(const QVariantMap &settings = QVariantMap()) = 0;
+ virtual State init(const QVariantMap &settings = QVariantMap(),
+ const QProcessEnvironment &environment = {},
+ bool loadFromEnvironment = false) = 0;
//! Makes temp data persistent
/** This Method is periodically called by the Quassel Core to make temporary
* \param password The cleartext password for the new user
* \return The new user's UserId
*/
- virtual UserId addUser(const QString &user, const QString &password) = 0;
+ virtual UserId addUser(const QString &user, const QString &password, const QString &authenticator = "Database") = 0;
//! Update a core user's password.
/** \param user The user's id
*/
virtual UserId getUserId(const QString &username) = 0;
+ //! Get the authentication provider for a given user.
+ /** \param username The username to validate
+ * \return The name of the auth provider if the UserId exists, "" otherwise.
+ */
+ virtual QString getUserAuthenticator(const UserId userid) = 0;
+
+
//! Determine the UserId of the internal user
/** \return A valid UserId if the password matches the username; 0 else
*/
*/
virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()) = 0;
+ //! Store core state
+ /**
+ * \param data Active Sessions
+ */
+ virtual void setCoreState(const QVariantList &data) = 0;
+
+ //! Retrieve core state
+ /**
+ * \param default Value to return in case it's unset.
+ * \return Active Sessions
+ */
+ virtual QVariantList getCoreState(const QVariantList &data = QVariantList()) = 0;
+
/* Identity handling */
virtual IdentityId createIdentity(UserId user, CoreIdentity &identity) = 0;
virtual bool updateIdentity(UserId user, const CoreIdentity &identity) = 0;
*/
virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user) = 0;
+ //! Update the BufferActivity for a Buffer
+ /** This Method is used to make the activity state of a Buffer persistent
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of that Buffer
+ * \param bufferId The buffer id
+ * \param MsgId The Message id where the marker line should be placed
+ */
+ virtual void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) = 0;
+
+ //! Get a Hash of all buffer activity states
+ /** This Method is called when the Quassel Core is started to restore the BufferActivities
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of the buffers
+ */
+ virtual QHash<BufferId, Message::Types> bufferActivities(UserId id) = 0;
+
+ //! Get the bitset of buffer activity states for a buffer
+ /** This method is used to load the activity state of a buffer when its last seen message changes.
+ * \note This method is threadsafe.
+ *
+ * \param bufferId The buffer
+ * \param lastSeenMsgId The last seen message
+ */
+ virtual Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) = 0;
+
+ //! Get a hash of buffers with their ciphers for a given network
+ /** The keys are channel names and values are ciphers (possibly empty)
+ * \note This method is threadsafe
+ *
+ * \param user The id of the networks owner
+ * \param networkId The Id of the network
+ */
+ virtual QHash<QString, QByteArray> bufferCiphers(UserId user, const NetworkId &networkId) = 0;
+
+ //! Update the cipher of a buffer
+ /** \note This method is threadsafe
+ *
+ * \param user The Id of the networks owner
+ * \param networkId The Id of the network
+ * \param bufferName The Cname of the buffer
+ * \param cipher The cipher for the buffer
+ */
+ virtual void setBufferCipher(UserId user, const NetworkId &networkId, const QString &bufferName, const QByteArray &cipher) = 0;
+
+ //! Update the highlight count for a Buffer
+ /** This Method is used to make the activity state of a Buffer persistent
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of that Buffer
+ * \param bufferId The buffer id
+ * \param MsgId The Message id where the marker line should be placed
+ */
+ virtual void setHighlightCount(UserId id, BufferId bufferId, int count) = 0;
+
+ //! Get a Hash of all highlight count states
+ /** This Method is called when the Quassel Core is started to restore the HighlightCounts
+ * \note This method is threadsafe.
+ *
+ * \param user The Owner of the buffers
+ */
+ virtual QHash<BufferId, int> highlightCounts(UserId id) = 0;
+
+ //! Get the highlight count states for a buffer
+ /** This method is used to load the activity state of a buffer when its last seen message changes.
+ * \note This method is threadsafe.
+ *
+ * \param bufferId The buffer
+ * \param lastSeenMsgId The last seen message
+ */
+ virtual int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) = 0;
+
/* Message handling */
//! Store a Message in the storage backend and set its unique Id.
*/
virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
+ //! Request a certain number messages stored in a given buffer, matching certain filters
+ /** \param buffer The buffer we request messages from
+ * \param first if != -1 return only messages with a MsgId >= first
+ * \param last if != -1 return only messages with a MsgId < last
+ * \param limit if != -1 limit the returned list to a max of \limit entries
+ * \param type The Message::Types that should be returned
+ * \return The requested list of messages
+ */
+ virtual QList<Message> requestMsgsFiltered(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1,
+ int limit = -1, Message::Types type = Message::Types{-1},
+ Message::Flags flags = Message::Flags{-1}) = 0;
+
//! Request a certain number of messages across all buffers
/** \param first if != -1 return only messages with a MsgId >= first
* \param last if != -1 return only messages with a MsgId < last
*/
virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) = 0;
+ //! Request a certain number of messages across all buffers, matching certain filters
+ /** \param first if != -1 return only messages with a MsgId >= first
+ * \param last if != -1 return only messages with a MsgId < last
+ * \param limit Max amount of messages
+ * \param type The Message::Types that should be returned
+ * \return The requested list of messages
+ */
+ virtual QList<Message> requestAllMsgsFiltered(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1,
+ Message::Types type = Message::Types{-1},
+ Message::Flags flags = Message::Flags{-1}) = 0;
+
+ //! Fetch all authusernames
+ /** \return Map of all current UserIds to permitted idents
+ */
+ virtual QMap<UserId, QString> getAllAuthUserNames() = 0;
+
signals:
//! Sent when a new BufferInfo is created, or an existing one changed somehow.
void bufferInfoUpdated(UserId user, const BufferInfo &);
//! Sent when a user has been removed
void userRemoved(UserId);
+ //! Emitted when database schema upgrade starts or ends
+ void dbUpgradeInProgress(bool inProgress);
+
protected:
- //! when implementing a storage handler, use this method to crypt user passwords.
- /** This guarantees compatibility with other storage handlers and allows easy migration
- */
- QString cryptedPassword(const QString &password);
+ QString hashPassword(const QString &password);
+ bool checkHashedPassword(const UserId user, const QString &password, const QString &hashedPassword, const Storage::HashVersion version);
+
+private:
+ QString hashPasswordSha1(const QString &password);
+ bool checkHashedPasswordSha1(const QString &password, const QString &hashedPassword);
+
+ QString hashPasswordSha2_512(const QString &password);
+ bool checkHashedPasswordSha2_512(const QString &password, const QString &hashedPassword);
+ QString sha2_512(const QString &input);
};