X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=420cc62a8ef74710e64937bba43ad60ee5091a33;hp=2255f56a03d389a2389893beffb4a776153bdf42;hb=8f976cfdc7090cf4a752dab08126cc6107aa9626;hpb=ef1ee865c342a16daab514a99110f56150ea95e7 diff --git a/src/core/core.h b/src/core/core.h index 2255f56a..420cc62a 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel Project * + * Copyright (C) 2005-2016 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,36 +15,51 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef _CORE_H_ -#define _CORE_H_ +#pragma once + +#include +#include #include -#include #include #include #include -#include -#include +#ifdef HAVE_SSL +# include +# include "sslserver.h" +#else +# include +# include +#endif + +#include "authenticator.h" #include "bufferinfo.h" +#include "deferredptr.h" #include "message.h" -#include "global.h" +#include "oidentdconfiggenerator.h" #include "sessionthread.h" +#include "storage.h" #include "types.h" +class CoreAuthHandler; class CoreSession; -class SessionThread; -class Storage; struct NetworkInfo; +class SessionThread; +class SignalProxy; -class Core : public QObject { - Q_OBJECT +class AbstractSqlMigrationReader; +class AbstractSqlMigrationWriter; - public: - static Core * instance(); +class Core : public QObject +{ + Q_OBJECT + +public: + static Core *instance(); static void destroy(); static void saveState(); @@ -53,6 +68,112 @@ class Core : public QObject { /*** Storage access ***/ // These methods are threadsafe. + //! Validate user + /** + * \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 validateUser(const QString &userName, const QString &password) { + 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 + * \param settingName The Name of the Setting + * \param data The Value + */ + static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) + { + instance()->_storage->setUserSetting(userId, settingName, data); + } + + + //! Retrieve a persistent user setting + /** + * \param userId The users Id + * \param settingName The Name of the Setting + * \param defaultValue Value to return in case it's unset. + * \return the Value of the Setting or the default value if it is unset. + */ + static inline QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultValue = QVariant()) + { + return instance()->_storage->getUserSetting(userId, settingName, defaultValue); + } + + + /* Identity handling */ + static inline IdentityId createIdentity(UserId user, CoreIdentity &identity) + { + return instance()->_storage->createIdentity(user, identity); + } + + + static bool updateIdentity(UserId user, const CoreIdentity &identity) + { + return instance()->_storage->updateIdentity(user, identity); + } + + + static void removeIdentity(UserId user, IdentityId identityId) + { + instance()->_storage->removeIdentity(user, identityId); + } + + + static QList identities(UserId user) + { + return instance()->_storage->identities(user); + } + + //! Create a Network in the Storage and store it's Id in the given NetworkInfo /** \note This method is thredsafe. * @@ -61,7 +182,7 @@ class Core : public QObject { * \return true if successfull. */ static bool createNetwork(UserId user, NetworkInfo &info); - + //! Apply the changes to NetworkInfo info to the storage engine /** \note This method is thredsafe. * @@ -69,7 +190,11 @@ class Core : public QObject { * \param networkInfo The Updated NetworkInfo * \return true if successfull. */ - static bool updateNetwork(UserId user, const NetworkInfo &info); + static inline bool updateNetwork(UserId user, const NetworkInfo &info) + { + return instance()->_storage->updateNetwork(user, info); + } + //! Permanently remove a Network and all the data associated with it. /** \note This method is thredsafe. @@ -78,24 +203,23 @@ class Core : public QObject { * \param networkId The network to delete * \return true if successfull. */ - static bool removeNetwork(UserId user, const NetworkId &networkId); - + static inline bool removeNetwork(UserId user, const NetworkId &networkId) + { + return instance()->_storage->removeNetwork(user, networkId); + } + + //! Returns a list of all NetworkInfos for the given UserId user /** \note This method is thredsafe. * * \param user The core user * \return QList. */ - static QList networks(UserId user); + static inline QList networks(UserId user) + { + return instance()->_storage->networks(user); + } - //! Get the NetworkId for a network name. - /** \note This method is threadsafe. - * - * \param user The core user - * \param network The name of the network - * \return The NetworkId corresponding to the given network. - */ - static NetworkId networkId(UserId user, const QString &network); //! Get a list of Networks to restore /** Return a list of networks the user was connected at the time of core shutdown @@ -103,7 +227,11 @@ class Core : public QObject { * * \param user The User Id in question */ - static QList connectedNetworks(UserId user); + static inline QList connectedNetworks(UserId user) + { + return instance()->_storage->connectedNetworks(user); + } + //! Update the connected state of a network /** \note This method is threadsafe @@ -112,7 +240,11 @@ class Core : public QObject { * \param networkId The Id of the network * \param isConnected whether the network is connected or not */ - static void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected); + static inline void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) + { + return instance()->_storage->setNetworkConnected(user, networkId, isConnected); + } + //! Get a hash of channels with their channel keys for a given network /** The keys are channel names and values are passwords (possibly empty) @@ -121,7 +253,11 @@ class Core : public QObject { * \param user The id of the networks owner * \param networkId The Id of the network */ - static QHash persistentChannels(UserId user, const NetworkId &networkId); + static inline QHash persistentChannels(UserId user, const NetworkId &networkId) + { + return instance()->_storage->persistentChannels(user, networkId); + } + //! Update the connected state of a channel /** \note This method is threadsafe @@ -131,7 +267,11 @@ class Core : public QObject { * \param channel The name of the channel * \param isJoined whether the channel is connected or not */ - static void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined); + static inline void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) + { + return instance()->_storage->setChannelPersistent(user, networkId, channel, isJoined); + } + //! Update the key of a channel /** \note This method is threadsafe @@ -141,7 +281,61 @@ class Core : public QObject { * \param channel The name of the channel * \param key The key of the channel (possibly empty) */ - static void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key); + static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) + { + return instance()->_storage->setPersistentChannelKey(user, networkId, channel, key); + } + + + //! retrieve last known away message for session restore + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + */ + static inline QString awayMessage(UserId user, NetworkId networkId) + { + return instance()->_storage->awayMessage(user, networkId); + } + + + //! Make away message persistent for session restore + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param awayMsg The current away message of own user + */ + static inline void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) + { + return instance()->_storage->setAwayMessage(user, networkId, awayMsg); + } + + + //! retrieve last known user mode for session restore + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + */ + static inline QString userModes(UserId user, NetworkId networkId) + { + return instance()->_storage->userModes(user, networkId); + } + + + //! Make our user modes persistent for session restore + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param userModes The current user modes of own user + */ + static inline void setUserModes(UserId user, NetworkId networkId, const QString &userModes) + { + return instance()->_storage->setUserModes(user, networkId, userModes); + } + //! Get the unique BufferInfo for the given combination of network and buffername for a user. /** \note This method is threadsafe. @@ -150,9 +344,14 @@ class Core : public QObject { * \param networkId The network id * \param type The type of the buffer (StatusBuffer, Channel, etc.) * \param buffer The buffer name (if empty, the net's status buffer is returned) + * \param create Whether or not the buffer should be created if it doesnt exist * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found */ - static BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type, const QString &buffer = ""); + static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) + { + return instance()->_storage->bufferInfo(user, networkId, type, buffer, create); + } + //! Get the unique BufferInfo for a bufferId /** \note This method is threadsafe @@ -160,58 +359,86 @@ class Core : public QObject { * \param bufferId The id of the buffer * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found. */ - static BufferInfo getBufferInfo(UserId user, const BufferId &bufferId); + static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) + { + return instance()->_storage->getBufferInfo(user, bufferId); + } + - - //! Store a Message in the backlog. + //! Store a Message in the storage backend and set it's unique Id. /** \note This method is threadsafe. * - * \param msg The message object to be stored - * \return The globally unique id for the stored message + * \param message The message object to be stored + * \return true on success */ - static MsgId storeMessage(const Message &message); + static inline bool storeMessage(Message &message) + { + return instance()->_storage->logMessage(message); + } - //! Request a certain number (or all) messages stored in a given buffer. + + //! Store a list of Messages in the storage backend and set their unique Id. /** \note This method is threadsafe. * - * \param buffer The buffer we request messages from - * \param lastmsgs The number of messages we would like to receive, or -1 if we'd like all messages from that buffername - * \param offset Do not return (but DO count) messages with MsgId >= offset, if offset >= 0 - * \return The requested list of messages + * \param messages The list message objects to be stored + * \return true on success */ - static QList requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1); + static inline bool storeMessages(MessageList &messages) + { + return instance()->_storage->logMessages(messages); + } - //! Request messages stored in a given buffer since a certain point in time. - /** \note This method is threadsafe. - * - * \param buffer The buffer we request messages from - * \param since Only return messages newer than this point in time - * \param offset Do not return messages with MsgId >= offset, if offset >= 0 + + //! Request a certain number messages stored in a given buffer. + /** \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 * \return The requested list of messages */ - static QList requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1); + static inline QList requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) + { + return instance()->_storage->requestMsgs(user, bufferId, first, last, limit); + } - //! Request a range of messages stored in a given buffer. - /** \note This method is threadsafe. - * - * \param buffer The buffer we request messages from - * \param first Return messages with first <= MsgId <= last - * \param last Return messages with first <= MsgId <= last + + //! 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 + * \param limit Max amount of messages * \return The requested list of messages */ - static QList requestMsgRange(BufferInfo buffer, int first, int last); + static inline QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) + { + return instance()->_storage->requestAllMsgs(user, first, last, limit); + } + - //! Request a list of all buffers known to a user since a certain point in time. + //! 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. - * Optionally, a QDateTime can be given, so that only buffers are listed that were active - * since that point in time. * \note This method is threadsafe. * * \param user The user whose buffers we request - * \param since If this is defined, older buffers will be ignored * \return A list of the BufferInfos for all buffers as requested */ - static QList requestBuffers(UserId user, QDateTime since = QDateTime()); + static inline QList requestBuffers(UserId user) + { + return instance()->_storage->requestBuffers(user); + } + + + //! Request a list of BufferIds for a given NetworkId + /** \note This method is threadsafe. + * + * \param user The user whose buffers we request + * \param networkId The NetworkId of the network in question + * \return List of BufferIds belonging to the Network + */ + static inline QList requestBufferIdsForNetwork(UserId user, NetworkId networkId) + { + return instance()->_storage->requestBufferIdsForNetwork(user, networkId); + } + //! Remove permanently a buffer and it's content from the storage backend /** This call cannot be reverted! @@ -221,17 +448,37 @@ class Core : public QObject { * \param bufferId The bufferId * \return true if successfull */ - static bool removeBuffer(const UserId &user, const BufferId &bufferId); + static inline bool removeBuffer(const UserId &user, const BufferId &bufferId) + { + return instance()->_storage->removeBuffer(user, bufferId); + } + //! Rename a Buffer /** \note This method is threadsafe. * \param user The id of the buffer owner - * \param networkId The id of the network the buffer belongs to + * \param bufferId The bufferId * \param newName The new name of the buffer - * \param oldName The previous name of the buffer - * \return the BufferId of the affected buffer or an invalid BufferId if not successfull + * \return true if successfull */ - static BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName); + static inline bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) + { + return instance()->_storage->renameBuffer(user, bufferId, newName); + } + + + //! Merge the content of two Buffers permanently. This cannot be reversed! + /** \note This method is threadsafe. + * \param user The id of the buffer owner + * \param bufferId1 The bufferId of the remaining buffer + * \param bufferId2 The buffer that is about to be removed + * \return true if successfulln + */ + static inline bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) + { + return instance()->_storage->mergeBuffersPermanently(user, bufferId1, bufferId2); + } + //! Update the LastSeenDate for a Buffer /** This Method is used to make the LastSeenDate of a Buffer persistent @@ -239,67 +486,198 @@ class Core : public QObject { * * \param user The Owner of that Buffer * \param bufferId The buffer id - * \param seenDate Time the Buffer has been visited the last time + * \param MsgId The Message id of the message that has been just seen + */ + static inline void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) + { + return instance()->_storage->setBufferLastSeenMsg(user, bufferId, msgId); + } + + + //! 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. + * + * \param user The Owner of the buffers + */ + static inline QHash bufferLastSeenMsgIds(UserId user) + { + return instance()->_storage->bufferLastSeenMsgIds(user); + } + + + //! Update the MarkerLineMsgId for a Buffer + /** This Method is used to make the marker line position 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 setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) + { + return instance()->_storage->setBufferMarkerLineMsg(user, bufferId, msgId); + } + + + //! Get a Hash of all marker line message ids + /** This Method is called when the Quassel Core is started to restore the MarkerLineMsgIds + * \note This method is threadsafe. + * + * \param user The Owner of the buffers + */ + static inline QHash bufferMarkerLineMsgIds(UserId user) + { + 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 void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate); + static inline void setBufferActivity(UserId user, const BufferId &bufferId, const Message::Types &activity) { + return instance()->_storage->setBufferActivity(user, bufferId, activity); + } + - //! Get a Hash of all last seen dates. - /** This Method is called when the Quassel Core is started to restore the lastSeenDates + //! 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 QHash bufferLastSeenDates(UserId user); + 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, const MsgId &lastSeenMsgId) { + return instance()->_storage->bufferActivity(bufferId, lastSeenMsgId); + } + + static inline QDateTime startTime() { return instance()->_startTime; } + static inline bool isConfigured() { return instance()->_configured; } + static bool sslSupported(); + + /** + * Reloads SSL certificates used for connection with clients + * + * @return True if certificates reloaded successfully, otherwise false. + */ + static bool reloadCerts(); + + static QVariantList backendInfo(); + static QVariantList authenticatorInfo(); + + 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; } - public slots: + inline OidentdConfigGenerator *oidentdConfigGenerator() const { return _oidentdConfigGenerator; } + + static const int AddClientEventId; + +public slots: //! Make storage data persistent /** \note This method is threadsafe. */ void syncStorage(); - - signals: + void setupInternalClientSession(InternalPeer *clientConnection); + QString setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupMap); + +signals: //! Sent when a BufferInfo is updated in storage. void bufferInfoUpdated(UserId user, const BufferInfo &info); - private slots: - bool startListening(uint port = Global::defaultPort); - void stopListening(); + //! Relay from CoreSession::sessionState(). Used for internal connection only + void sessionState(const Protocol::SessionState &sessionState); + +protected: + virtual void customEvent(QEvent *event); + +private slots: + bool startListening(); + void stopListening(const QString &msg = QString()); void incomingConnection(); - void clientHasData(); void clientDisconnected(); - bool initStorage(QVariantMap dbSettings, bool setup = false); + bool initStorage(const QString &backend, const QVariantMap &settings, bool setup = false); + bool initAuthenticator(const QString &backend, const QVariantMap &settings, bool setup = false); - private: + void socketError(QAbstractSocket::SocketError err, const QString &errorString); + void setupClientSession(RemotePeer *, UserId); + + bool changeUserPass(const QString &username); + +private: Core(); ~Core(); void init(); static Core *instanceptr; - SessionThread *createSession(UserId userId, bool restoreState = false); - void setupClientSession(QTcpSocket *socket, UserId uid); - void processClientMessage(QTcpSocket *socket, const QVariantMap &msg); + SessionThread *sessionForUser(UserId userId, bool restoreState = false); + void addClientHelper(RemotePeer *peer, UserId uid); //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg); - QString setupCore(const QVariant &setupData); + QString setupCoreForInternalUsage(); - bool registerStorageBackend(Storage *); - void unregisterStorageBackend(Storage *); + bool createUser(); - QHash sessions; - Storage *storage; - QTimer _storageSyncTimer; + template + void registerStorageBackend(); - QTcpServer server; // TODO: implement SSL - QHash blocksizes; - QHash clientInfo; + template + void registerAuthenticator(); - QHash _storageBackends; + void registerStorageBackends(); + void registerAuthenticators(); - QDateTime startTime; + DeferredSharedPtr storageBackend(const QString& backendId) const; + DeferredSharedPtr authenticator(const QString& authenticatorId) const; - bool configured; + bool selectBackend(const QString &backend); + bool selectAuthenticator(const QString &backend); - static QMutex mutex; -}; + bool saveBackendSettings(const QString &backend, const QVariantMap &settings); + void saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings); + template + QVariantMap promptForSettings(const Backend *backend); + +private: + QSet _connectingClients; + QHash _sessions; + DeferredSharedPtr _storage; ///< Active storage backend + DeferredSharedPtr _authenticator; ///< Active authenticator + QTimer _storageSyncTimer; + +#ifdef HAVE_SSL + SslServer _server, _v6server; +#else + QTcpServer _server, _v6server; #endif + + OidentdConfigGenerator *_oidentdConfigGenerator {nullptr}; + + std::vector> _registeredStorageBackends; + std::vector> _registeredAuthenticators; + + QDateTime _startTime; + + bool _configured; + + 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); } +};