X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=6ee511a4f590d02a62ae2da0fca1e8e51cc02797;hp=1aa2fa384e6aa453a5ca968141ffd255ed2187a2;hb=0a79f71c41f69643fdbf0c32c061f1b11d14346d;hpb=674ad8ee4369cbc9516eb6d6629a616e9310c71f diff --git a/src/core/core.h b/src/core/core.h index 1aa2fa38..6ee511a4 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-09 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -34,10 +34,11 @@ # include #endif -#include "storage.h" #include "bufferinfo.h" #include "message.h" +#include "oidentdconfiggenerator.h" #include "sessionthread.h" +#include "storage.h" #include "types.h" class CoreSession; @@ -45,11 +46,14 @@ class SessionThread; class SignalProxy; struct NetworkInfo; +class AbstractSqlMigrationReader; +class AbstractSqlMigrationWriter; + class Core : public QObject { Q_OBJECT - public: - static Core * instance(); +public: + static Core *instance(); static void destroy(); static void saveState(); @@ -65,32 +69,32 @@ class Core : public QObject { * \param data The Value */ static inline void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) { - instance()->storage->setUserSetting(userId, settingName, 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. + * \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 &data = QVariant()) { - return instance()->storage->getUserSetting(userId, settingName, data); + 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); + return instance()->_storage->createIdentity(user, identity); } static bool updateIdentity(UserId user, const CoreIdentity &identity) { - return instance()->storage->updateIdentity(user, identity); + return instance()->_storage->updateIdentity(user, identity); } static void removeIdentity(UserId user, IdentityId identityId) { - instance()->storage->removeIdentity(user, identityId); + instance()->_storage->removeIdentity(user, identityId); } static QList identities(UserId user) { - return instance()->storage->identities(user); + return instance()->_storage->identities(user); } //! Create a Network in the Storage and store it's Id in the given NetworkInfo @@ -110,7 +114,7 @@ class Core : public QObject { * \return true if successfull. */ static inline bool updateNetwork(UserId user, const NetworkInfo &info) { - return instance()->storage->updateNetwork(user, info); + return instance()->_storage->updateNetwork(user, info); } //! Permanently remove a Network and all the data associated with it. @@ -121,7 +125,7 @@ class Core : public QObject { * \return true if successfull. */ static inline bool removeNetwork(UserId user, const NetworkId &networkId) { - return instance()->storage->removeNetwork(user, networkId); + return instance()->_storage->removeNetwork(user, networkId); } //! Returns a list of all NetworkInfos for the given UserId user @@ -131,18 +135,7 @@ class Core : public QObject { * \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); + return instance()->_storage->networks(user); } //! Get a list of Networks to restore @@ -152,7 +145,7 @@ class Core : public QObject { * \param user The User Id in question */ static inline QList connectedNetworks(UserId user) { - return instance()->storage->connectedNetworks(user); + return instance()->_storage->connectedNetworks(user); } //! Update the connected state of a network @@ -163,7 +156,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setNetworkConnected(user, networkId, isConnected); } //! Get a hash of channels with their channel keys for a given network @@ -174,7 +167,7 @@ class Core : public QObject { * \param networkId The Id of the network */ static inline QHash persistentChannels(UserId user, const NetworkId &networkId) { - return instance()->storage->persistentChannels(user, networkId); + return instance()->_storage->persistentChannels(user, networkId); } //! Update the connected state of a channel @@ -186,7 +179,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setChannelPersistent(user, networkId, channel, isJoined); } //! Update the key of a channel @@ -198,7 +191,49 @@ class Core : public QObject { * \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); + 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. @@ -212,7 +247,7 @@ class Core : public QObject { * \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 = "", bool create = true) { - return instance()->storage->bufferInfo(user, networkId, type, buffer, create); + return instance()->_storage->bufferInfo(user, networkId, type, buffer, create); } //! Get the unique BufferInfo for a bufferId @@ -222,17 +257,27 @@ class Core : public QObject { * \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); + 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 inline MsgId storeMessage(const Message &message) { - return instance()->storage->logMessage(message); + static inline bool storeMessage(Message &message) { + return instance()->_storage->logMessage(message); + } + + //! Store a list of Messages in the storage backend and set their unique Id. + /** \note This method is threadsafe. + * + * \param messages The list message objects to be stored + * \return true on success + */ + static inline bool storeMessages(MessageList &messages) { + return instance()->_storage->logMessages(messages); } //! Request a certain number messages stored in a given buffer. @@ -243,7 +288,7 @@ class Core : public QObject { * \return The requested list of messages */ 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); + return instance()->_storage->requestMsgs(user, bufferId, first, last, limit); } //! Request a certain number of messages across all buffers @@ -253,7 +298,7 @@ class Core : public QObject { * \return The requested list of messages */ static inline QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) { - return instance()->storage->requestAllMsgs(user, first, last, limit); + return instance()->_storage->requestAllMsgs(user, first, last, limit); } //! Request a list of all buffers known to a user. @@ -264,7 +309,7 @@ class Core : public QObject { * \return A list of the BufferInfos for all buffers as requested */ static inline QList requestBuffers(UserId user) { - return instance()->storage->requestBuffers(user); + return instance()->_storage->requestBuffers(user); } //! Request a list of BufferIds for a given NetworkId @@ -275,7 +320,7 @@ class Core : public QObject { * \return List of BufferIds belonging to the Network */ static inline QList requestBufferIdsForNetwork(UserId user, NetworkId networkId) { - return instance()->storage->requestBufferIdsForNetwork(user, networkId); + return instance()->_storage->requestBufferIdsForNetwork(user, networkId); } //! Remove permanently a buffer and it's content from the storage backend @@ -287,7 +332,7 @@ class Core : public QObject { * \return true if successfull */ static inline bool removeBuffer(const UserId &user, const BufferId &bufferId) { - return instance()->storage->removeBuffer(user, bufferId); + return instance()->_storage->removeBuffer(user, bufferId); } //! Rename a Buffer @@ -298,7 +343,7 @@ class Core : public QObject { * \return true if successfull */ static inline bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) { - return instance()->storage->renameBuffer(user, bufferId, newName); + return instance()->_storage->renameBuffer(user, bufferId, newName); } //! Merge the content of two Buffers permanently. This cannot be reversed! @@ -309,7 +354,7 @@ class Core : public QObject { * \return true if successfulln */ static inline bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) { - return instance()->storage->mergeBuffersPermanently(user, bufferId1, bufferId2); + return instance()->_storage->mergeBuffersPermanently(user, bufferId1, bufferId2); } //! Update the LastSeenDate for a Buffer @@ -321,7 +366,7 @@ class Core : public QObject { * \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); + return instance()->_storage->setBufferLastSeenMsg(user, bufferId, msgId); } //! Get a Hash of all last seen message ids @@ -331,19 +376,46 @@ class Core : public QObject { * \param user The Owner of the buffers */ static inline QHash bufferLastSeenMsgIds(UserId user) { - return instance()->storage->bufferLastSeenMsgIds(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); } const QDateTime &startTime() const { return _startTime; } static inline QTimer &syncTimer() { return instance()->_storageSyncTimer; } + inline OidentdConfigGenerator *oidentdConfigGenerator() const { return _oidentdConfigGenerator; } + + static const int AddClientEventId; + 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); @@ -351,6 +423,9 @@ signals: //! Relay From CoreSession::sessionState(const QVariant &). Used for internal connection only void sessionState(const QVariant &); +protected: + virtual void customEvent(QEvent *event); + private slots: bool startListening(); void stopListening(const QString &msg = QString()); @@ -358,6 +433,7 @@ private slots: void clientHasData(); void clientDisconnected(); + bool initStorage(const QString &backend, QVariantMap settings, bool setup = false); bool initStorage(QVariantMap dbSettings, bool setup = false); #ifdef HAVE_SSL @@ -373,16 +449,24 @@ private: SessionThread *createSession(UserId userId, bool restoreState = false); void setupClientSession(QTcpSocket *socket, UserId uid); + void addClientHelper(QTcpSocket *socket, UserId uid); void processClientMessage(QTcpSocket *socket, const QVariantMap &msg); //void processCoreSetup(QTcpSocket *socket, QVariantMap &msg); QString setupCoreForInternalUsage(); QString setupCore(QVariantMap setupData); + void registerStorageBackends(); bool registerStorageBackend(Storage *); + void unregisterStorageBackends(); void unregisterStorageBackend(Storage *); + 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); QHash sessions; - Storage *storage; + Storage *_storage; QTimer _storageSyncTimer; #ifdef HAVE_SSL @@ -391,6 +475,8 @@ private: QTcpServer _server, _v6server; #endif + OidentdConfigGenerator *_oidentdConfigGenerator; + QHash blocksizes; QHash clientInfo; @@ -398,7 +484,14 @@ private: QDateTime _startTime; - bool configured; + bool _configured; + + + static AbstractSqlMigrationReader *getMigrationReader(Storage *storage); + static AbstractSqlMigrationWriter *getMigrationWriter(Storage *storage); + static void stdInEcho(bool on); + static inline void enableStdInEcho() { stdInEcho(true); } + static inline void disableStdInEcho() { stdInEcho(false); } }; #endif