X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=1c2e0db08b77da23e69ae035ae6a34147d1c75e2;hp=091c0f71bbd8a3b9179672e541ee3bd8540811b1;hb=4bb7c6540eb44dc47b2b93051a46c5bdc9a7f5ba;hpb=59579d82e3a16a815a197a4300c8ef279275ccfc diff --git a/src/core/core.h b/src/core/core.h index 091c0f71..1c2e0db0 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -18,164 +18,376 @@ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#ifndef _CORE_H_ -#define _CORE_H_ +#ifndef CORE_H +#define CORE_H #include -#include #include #include #include -#include -#include +#ifdef HAVE_SSL +# include +# include "sslserver.h" +#else +# include +# include +#endif + +#include "storage.h" #include "bufferinfo.h" #include "message.h" -#include "global.h" #include "sessionthread.h" #include "types.h" class CoreSession; class SessionThread; -class Storage; +class SignalProxy; struct NetworkInfo; class Core : public QObject { Q_OBJECT public: - static Core * instance(); - static void destroy(); - - static void saveState(); - static void restoreState(); - - /*** Storage access ***/ - // These methods are threadsafe. - - //! Create a NetworkId in the Storage and store it in the given NetworkInfo - /** \note This method is thredsafe. - * - * \param user The core user - * \param networkInfo a NetworkInfo definition to store the newly created ID in - * \return true if successfull. - */ - static bool createNetworkId(UserId user, NetworkInfo &info); - - //! 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 the unique BufferInfo for the given combination of network and buffername for a user. - /** \note This method is threadsafe. - * - * \param user The core user who owns this buffername - * \param networkId The network id - * \param buffer The buffer name (if empty, the net's status buffer is returned) - * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found - */ - static BufferInfo bufferInfo(UserId user, const NetworkId &networkId, const QString &buffer = ""); - - //! Store a Message in the backlog. - /** \note This method is threadsafe. - * - * \param msg The message object to be stored - * \return The globally unique id for the stored message - */ - static MsgId storeMessage(const Message &message); - - //! Request a certain number (or all) messages stored in a given buffer. - /** \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 - */ - static QList requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1); - - //! 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 - * \return The requested list of messages - */ - static QList requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1); - - //! 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 - * \return The requested list of messages - */ - static QList requestMsgRange(BufferInfo buffer, int first, int last); - - //! Request a list of all buffers known to a user since a certain point in time. - /** 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()); - - public slots: - //! Make storage data persistent - /** \note This method is threadsafe. - */ - void syncStorage(); - - 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(); - void incomingConnection(); - void clientHasData(); - void clientDisconnected(); - - bool initStorage(QVariantMap dbSettings, bool setup = false); - - private: - Core(); - ~Core(); - void init(); - static Core *instanceptr; - - SessionThread *createSession(UserId userId, bool restoreState = false); - void setupClientSession(QTcpSocket *socket, UserId uid); - void processCoreSetup(QTcpSocket *socket, QVariantMap &msg); - - QStringList availableStorageProviders(); - - UserId guiUser; - QHash sessions; - Storage *storage; - QTimer _storageSyncTimer; - - QTcpServer server; // TODO: implement SSL - QHash blocksizes; - QHash clientInfo; - - QDateTime startTime; - - bool configured; - - static QMutex mutex; + static Core * instance(); + static void destroy(); + + static void saveState(); + static void restoreState(); + + /*** Storage access ***/ + // These methods are threadsafe. + + //! 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 default 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 &data = QVariant()) { + return instance()->storage->getUserSetting(userId, settingName, data); + } + + + //! Create a Network in the Storage and store it's Id in the given NetworkInfo + /** \note This method is thredsafe. + * + * \param user The core user + * \param networkInfo a NetworkInfo definition to store the newly created ID in + * \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. + * + * \param user The core user + * \param networkInfo The Updated NetworkInfo + * \return true if successfull. + */ + 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. + * + * \param user The core user + * \param networkId The network to delete + * \return true if successfull. + */ + 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 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 inline NetworkId networkId(UserId user, const QString &network) { + return instance()->storage->getNetworkId(user, network); + } + + //! Get a list of Networks to restore + /** Return a list of networks the user was connected at the time of core shutdown + * \note This method is threadsafe. + * + * \param user The User Id in question + */ + static inline QList connectedNetworks(UserId user) { + return instance()->storage->connectedNetworks(user); + } + + //! Update the connected state of a network + /** \note This method is threadsafe + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param isConnected whether the network is connected or not + */ + 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) + * \note This method is threadsafe + * + * \param user The id of the networks owner + * \param networkId The Id of the network + */ + 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 + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param channel The name of the channel + * \param isJoined whether the channel is connected or not + */ + 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 + * + * \param user The Id of the networks owner + * \param networkId The Id of the network + * \param channel The name of the channel + * \param key The key of the channel (possibly empty) + */ + static inline void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) { + return instance()->storage->setPersistentChannelKey(user, networkId, channel, key); + } + + //! Get the unique BufferInfo for the given combination of network and buffername for a user. + /** \note This method is threadsafe. + * + * \param user The core user who owns this buffername + * \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) + * \return The BufferInfo corresponding to the given network and buffer name, or 0 if not found + */ + static inline BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "") { + return instance()->storage->getBufferInfo(user, networkId, type, buffer); + } + + //! Get the unique BufferInfo for a bufferId + /** \note This method is threadsafe + * \param user The core user who owns this buffername + * \param bufferId The id of the buffer + * \return The BufferInfo corresponding to the given buffer id, or an invalid BufferInfo if not found. + */ + static inline BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) { + return instance()->storage->getBufferInfo(user, bufferId); + } + + //! Store a Message in the backlog. + /** \note This method is threadsafe. + * + * \param msg The message object to be stored + * \return The globally unique id for the stored message + */ + static inline MsgId storeMessage(const Message &message) { + return instance()->storage->logMessage(message); + } + + //! Request a certain number (or all) messages stored in a given buffer. + /** \note This method is threadsafe. + * + * \param buffer The buffer we request messages from + * \param limit 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 + */ + static inline QList requestMsgs(UserId user, BufferId buffer, int limit = -1, int offset = -1) { + return instance()->storage->requestMsgs(user, buffer, limit, offset); + } + + //! 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 + * \return The requested list of messages + */ + static inline QList requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset = -1) { + return instance()->storage->requestMsgs(user, buffer, since, offset); + } + + //! 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 + * \return The requested list of messages + */ + static inline QList requestMsgRange(UserId user, BufferId buffer, int first, int last) { + return instance()->storage->requestMsgRange(user, buffer, first, last); + } + + //! 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. + * + * \param user The user whose buffers we request + * \return A list of the BufferInfos for all buffers as requested + */ + 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! + * \note This method is threadsafe. + * + * \param user The user who is the owner of the buffer + * \param bufferId The bufferId + * \return true if successfull + */ + 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 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 + */ + static inline BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) { + return instance()->storage->renameBuffer(user, networkId, newName, oldName); + } + + //! Update the LastSeenDate for a Buffer + /** This Method is used to make the LastSeenDate 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 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); + } + + const QDateTime &startTime() const { return _startTime; } + +public slots: + //! Make storage data persistent + /** \note This method is threadsafe. + */ + void syncStorage(); + void setupInternalClientSession(SignalProxy *proxy); +signals: + //! Sent when a BufferInfo is updated in storage. + void bufferInfoUpdated(UserId user, const BufferInfo &info); + + //! Relay From CoreSession::sessionState(const QVariant &). Used for internal connection only + void sessionState(const QVariant &); + +private slots: + bool startListening(); + void stopListening(const QString &msg = QString()); + void incomingConnection(); + void clientHasData(); + void clientDisconnected(); + + bool initStorage(QVariantMap dbSettings, bool setup = false); + +#ifdef HAVE_SSL + void sslErrors(const QList &errors); +#endif + void socketError(QAbstractSocket::SocketError); + +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); + //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg); + QString setupCoreForInternalUsage(); + QString setupCore(QVariantMap setupData); + + bool registerStorageBackend(Storage *); + void unregisterStorageBackend(Storage *); + + QHash sessions; + Storage *storage; + QTimer _storageSyncTimer; + +#ifdef HAVE_SSL + SslServer _server, _v6server; +#else + QTcpServer _server, _v6server; +#endif + + QHash blocksizes; + QHash clientInfo; + + QHash _storageBackends; + + QDateTime _startTime; + + bool configured; }; #endif