X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=45d06072298569ad4cbdddb4900a7cbf6fb1892d;hp=d544744a3c41056280694d9db049e4d18e498596;hb=e8a39b4c3c92e193ab861a3fea84a261bb6fbd24;hpb=b65b9f7615165e8700a44d59b7275a55558dd45b diff --git a/src/core/core.h b/src/core/core.h index d544744a..45d06072 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2015 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 * @@ -18,10 +18,15 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef CORE_H -#define CORE_H +#pragma once + +#include "core-export.h" + +#include +#include #include +#include #include #include #include @@ -34,32 +39,43 @@ # include #endif +#include "authenticator.h" #include "bufferinfo.h" +#include "deferredptr.h" +#include "identserver.h" #include "message.h" #include "oidentdconfiggenerator.h" #include "sessionthread.h" +#include "singleton.h" #include "storage.h" #include "types.h" class CoreAuthHandler; class CoreSession; -struct NetworkInfo; +class InternalPeer; class SessionThread; class SignalProxy; +struct NetworkInfo; + class AbstractSqlMigrationReader; class AbstractSqlMigrationWriter; -class Core : public QObject +class CORE_EXPORT Core : public QObject, public Singleton { Q_OBJECT public: - static Core *instance(); - static void destroy(); + Core(); + ~Core() override; + + void init(); + + /** + * Shuts down active core sessions, saves state and emits the shutdownComplete() signal afterwards. + */ + void shutdown(); - static void saveState(); - static void restoreState(); /*** Storage access ***/ // These methods are threadsafe. @@ -74,6 +90,52 @@ public: return instance()->_storage->validateUser(userName, password); } + //! Authenticate user against auth backend + /** + * \param userName The user's login name + * \param password The user's uncrypted password + * \return The user's ID if valid; 0 otherwise + */ + static inline UserId authenticateUser(const QString &userName, const QString &password) { + return instance()->_authenticator->validateUser(userName, password); + } + + //! Add a new user, exposed so auth providers can call this without being the storage. + /** + * \param userName The user's login name + * \param password The user's uncrypted password + * \param authenticator The name of the auth provider service used to log the user in, defaults to "Database". + * \return The user's ID if valid; 0 otherwise + */ + static inline UserId addUser(const QString &userName, const QString &password, const QString &authenticator = "Database") { + return instance()->_storage->addUser(userName, password, authenticator); + } + + //! Does a comparison test against the authenticator in the database and the authenticator currently in use for a UserID. + /** + * \param userid The user's ID (note: not login name). + * \param authenticator The name of the auth provider service used to log the user in, defaults to "Database". + * \return True if the userid was configured with the passed authenticator, false otherwise. + */ + static inline bool checkAuthProvider(const UserId userid, const QString &authenticator) { + return instance()->_storage->getUserAuthenticator(userid) == authenticator; + } + + //! Change a user's password + /** + * \param userId The user's ID + * \param password The user's unencrypted new password + * \return true, if the password change was successful + */ + static bool changeUserPassword(UserId userId, const QString &password); + + //! Check if we can change a user password. + /** + * \param userID The user's ID + * \return true, if we can change their password, false otherwise + */ + static bool canChangeUserPassword(UserId userId); + //! Store a user setting persistently /** * \param userId The users Id @@ -223,6 +285,33 @@ public: } + //! 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 + */ + static inline QHash bufferCiphers(UserId user, const NetworkId &networkId) + { + return instance()->_storage->bufferCiphers(user, networkId); + } + + + //! 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 + */ + static inline void setBufferCipher(UserId user, const NetworkId &networkId, const QString &bufferName, const QByteArray &cipher) + { + return instance()->_storage->setBufferCipher(user, networkId, bufferName, cipher); + } + + //! Update the key of a channel /** \note This method is threadsafe * @@ -352,6 +441,22 @@ public: } + //! 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 + */ + static inline QList 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}) + { + return instance()->_storage->requestMsgsFiltered(user, bufferId, first, last, limit, type, flags); + } + + //! 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 @@ -364,6 +469,21 @@ public: } + //! 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 + */ + static inline QList requestAllMsgsFiltered(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1, + Message::Types type = Message::Types{-1}, + Message::Flags flags = Message::Flags{-1}) + { + return instance()->_storage->requestAllMsgsFiltered(user, first, last, limit, type, flags); + } + + //! Request a list of all buffers known to a user. /** This method is used to get a list of all buffers we have stored a backlog from. * \note This method is threadsafe. @@ -444,6 +564,13 @@ public: } + //! Get a usable sysident for the given user in oidentd-strict mode + /** \param user The user to retrieve the sysident for + * \return The authusername + */ + QString strictSysIdent(UserId user) const; + + //! Get a Hash of all last seen message ids /** This Method is called when the Quassel Core is started to restore the lastSeenMsgIds * \note This method is threadsafe. @@ -481,28 +608,97 @@ public: return instance()->_storage->bufferMarkerLineMsgIds(user); } + //! 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 + */ + static inline void setBufferActivity(UserId user, BufferId bufferId, Message::Types activity) { + return instance()->_storage->setBufferActivity(user, bufferId, activity); + } + + + //! Get a Hash of all buffer activity states + /** This Method is called when the Quassel Core is started to restore the BufferActivity + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + static inline QHash bufferActivities(UserId user) { + return instance()->_storage->bufferActivities(user); + } + + //! 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 + */ + static inline Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) { + return instance()->_storage->bufferActivity(bufferId, lastSeenMsgId); + } + + //! Update the highlight count for a Buffer + /** This Method is used to make the highlight count 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 + */ + static inline void setHighlightCount(UserId user, BufferId bufferId, int highlightCount) { + return instance()->_storage->setHighlightCount(user, bufferId, highlightCount); + } + + + //! Get a Hash of all highlight count states + /** This Method is called when the Quassel Core is started to restore the highlight count + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + static inline QHash highlightCounts(UserId user) { + return instance()->_storage->highlightCounts(user); + } + //! Get the highlight count states for a buffer + /** This method is used to load the highlight count of a buffer when its last seen message changes. + * \note This method is threadsafe. + * + * \param bufferId The buffer + * \param lastSeenMsgId The last seen message + */ + static inline int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) { + return instance()->_storage->highlightCount(bufferId, lastSeenMsgId); + } static inline QDateTime startTime() { return instance()->_startTime; } static inline bool isConfigured() { return instance()->_configured; } + + /** + * Whether or not strict ident mode is enabled, locking users' idents to Quassel username + * + * @return True if strict mode enabled, otherwise false + */ + static inline bool strictIdentEnabled() { return instance()->_strictIdentEnabled; } + static bool sslSupported(); + static QVariantList backendInfo(); + static QVariantList authenticatorInfo(); - static QString setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData); + static QString setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupMap); - static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; } + static inline QTimer *syncTimer() { return &instance()->_storageSyncTimer; } inline OidentdConfigGenerator *oidentdConfigGenerator() const { return _oidentdConfigGenerator; } + inline IdentServer *identServer() const { return _identServer; } static const int AddClientEventId; -public slots: - //! Make storage data persistent - /** \note This method is threadsafe. - */ - void syncStorage(); - void setupInternalClientSession(InternalPeer *clientConnection); - QString setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData); - signals: //! Sent when a BufferInfo is updated in storage. void bufferInfoUpdated(UserId user, const BufferInfo &info); @@ -510,8 +706,39 @@ signals: //! Relay from CoreSession::sessionState(). Used for internal connection only void sessionState(const Protocol::SessionState &sessionState); + //! Emitted when database schema upgrade starts or ends + void dbUpgradeInProgress(bool inProgress); + + //! Emitted when a fatal error was encountered during async initialization + void exitRequested(int exitCode, const QString &reason); + + //! Emitted once core shutdown is complete + void shutdownComplete(); + +public slots: + void initAsync(); + + /** Persist storage. + * + * @note This method is threadsafe. + */ + void syncStorage(); + + /** + * Reload SSL certificates used for connection with clients. + * + * @return True if certificates reloaded successfully, otherwise false. + */ + bool reloadCerts(); + + void cacheSysIdent(); + + QString setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupMap); + + void connectInternalPeer(QPointer peer); + protected: - virtual void customEvent(QEvent *event); + void customEvent(QEvent *event) override; private slots: bool startListening(); @@ -519,36 +746,61 @@ private slots: void incomingConnection(); void clientDisconnected(); - bool initStorage(const QString &backend, const QVariantMap &settings, bool setup = false); + bool initStorage(const QString &backend, const QVariantMap &settings, + const QProcessEnvironment &environment, bool loadFromEnvironment, + bool setup = false); + bool initAuthenticator(const QString &backend, const QVariantMap &settings, + const QProcessEnvironment &environment, bool loadFromEnvironment, + bool setup = false); void socketError(QAbstractSocket::SocketError err, const QString &errorString); void setupClientSession(RemotePeer *, UserId); -private: - Core(); - ~Core(); - void init(); - static Core *instanceptr; + bool changeUserPass(const QString &username); - SessionThread *createSession(UserId userId, bool restoreState = false); + void onSessionShutdown(SessionThread *session); + +private: + SessionThread *sessionForUser(UserId userId, bool restoreState = false); void addClientHelper(RemotePeer *peer, UserId uid); //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg); QString setupCoreForInternalUsage(); + void setupInternalClientSession(QPointer peer); + + bool createUser(); + + template + void registerStorageBackend(); + + template + void registerAuthenticator(); void registerStorageBackends(); - bool registerStorageBackend(Storage *); - void unregisterStorageBackends(); - void unregisterStorageBackend(Storage *); + void registerAuthenticators(); + + DeferredSharedPtr storageBackend(const QString& backendId) const; + DeferredSharedPtr authenticator(const QString& authenticatorId) const; + bool selectBackend(const QString &backend); - void createUser(); - void changeUserPass(const QString &username); - void saveBackendSettings(const QString &backend, const QVariantMap &settings); - QVariantMap promptForSettings(const Storage *storage); + bool selectAuthenticator(const QString &backend); + + bool saveBackendSettings(const QString &backend, const QVariantMap &settings); + void saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings); + + void saveState(); + void restoreState(); + + template + QVariantMap promptForSettings(const Backend *backend); private: + static Core *_instance; QSet _connectingClients; - QHash sessions; - Storage *_storage; + QHash _sessions; + DeferredSharedPtr _storage; ///< Active storage backend + DeferredSharedPtr _authenticator; ///< Active authenticator + QMap _authUserNames; + QTimer _storageSyncTimer; #ifdef HAVE_SSL @@ -557,20 +809,26 @@ private: QTcpServer _server, _v6server; #endif - OidentdConfigGenerator *_oidentdConfigGenerator; + OidentdConfigGenerator *_oidentdConfigGenerator {nullptr}; - QHash _storageBackends; + std::vector> _registeredStorageBackends; + std::vector> _registeredAuthenticators; QDateTime _startTime; - bool _configured; + IdentServer *_identServer {nullptr}; + + bool _initialized{false}; + bool _configured{false}; - static AbstractSqlMigrationReader *getMigrationReader(Storage *storage); - static AbstractSqlMigrationWriter *getMigrationWriter(Storage *storage); + QPointer _pendingInternalConnection; + + /// Whether or not strict ident mode is enabled, locking users' idents to Quassel username + bool _strictIdentEnabled; + + static std::unique_ptr getMigrationReader(Storage *storage); + static std::unique_ptr getMigrationWriter(Storage *storage); static void stdInEcho(bool on); static inline void enableStdInEcho() { stdInEcho(true); } static inline void disableStdInEcho() { stdInEcho(false); } }; - - -#endif