X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcore.h;h=a2a15ae4e61c23d3f2cccddf8d1bd6c86b237c07;hp=126e3a5799d69de7185618ef9e0cc9bbc7919c14;hb=1eb21546673535f5707aa6346e8c749b928cd772;hpb=077d44f36d2f5c730283ef6be839aea7dd073d56 diff --git a/src/core/core.h b/src/core/core.h index 126e3a57..a2a15ae4 100644 --- a/src/core/core.h +++ b/src/core/core.h @@ -1,11 +1,11 @@ /*************************************************************************** - * Copyright (C) 2005/06 by The Quassel Team * + * Copyright (C) 2005-08 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * + * (at your option) version 3. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -21,16 +21,30 @@ #ifndef _CORE_H_ #define _CORE_H_ +#include +#include #include #include -#include +#include + +#ifdef HAVE_SSL +# include +# include "sslserver.h" +#else +# include +# include +#endif -#include "server.h" -#include "storage.h" -#include "global.h" -#include "coreproxy.h" +#include "bufferinfo.h" +#include "message.h" +#include "sessionthread.h" +#include "types.h" class CoreSession; +class SessionThread; +class SignalProxy; +class Storage; +struct NetworkInfo; class Core : public QObject { Q_OBJECT @@ -39,18 +53,263 @@ class Core : public QObject { static Core * instance(); static void destroy(); - static CoreSession * session(UserId); - static CoreSession * localSession(); - static CoreSession * createSession(UserId); + 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 void setUserSetting(UserId userId, const QString &settingName, const QVariant &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 QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &data = QVariant()); + + + //! 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 bool updateNetwork(UserId user, const NetworkInfo &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 bool removeNetwork(UserId user, const NetworkId &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); + + //! 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 + * \note This method is threadsafe. + * + * \param user The User Id in question + */ + static QList connectedNetworks(UserId 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 void setNetworkConnected(UserId user, const NetworkId &networkId, bool 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 QHash persistentChannels(UserId user, const NetworkId &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 void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool 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 void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &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 BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type, const QString &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 BufferInfo getBufferInfo(UserId user, const BufferId &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 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(UserId user, BufferId 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(UserId user, BufferId 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(UserId user, BufferId buffer, int first, int 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 QList requestBuffers(UserId 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 QList requestBufferIdsForNetwork(UserId user, NetworkId 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 bool removeBuffer(const UserId &user, const BufferId &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 BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &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 void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &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 QHash bufferLastSeenMsgIds(UserId 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: - void recvProxySignal(CoreSignal, QVariant, QVariant, QVariant); - bool startListening(uint port = 4242); - void stopListening(); + bool startListening(); + void stopListening(const QString &msg = QString()); void incomingConnection(); void clientHasData(); void clientDisconnected(); - void updateGlobalData(UserId, QString); + + bool initStorage(QVariantMap dbSettings, bool setup = false); + +#ifdef HAVE_SSL + void sslErrors(const QList &errors); +#endif + void socketError(QAbstractSocket::SocketError); private: Core(); @@ -58,111 +317,36 @@ class Core : public QObject { void init(); static Core *instanceptr; - void processClientInit(QTcpSocket *socket, const QVariant &v); - void processClientUpdate(QTcpSocket *socket, QString key, const QVariant &data); - - UserId guiUser; - QHash sessions; - Storage *storage; - - QTcpServer server; // TODO: implement SSL - QHash validClients; - QHash blockSizes; -}; - -class CoreSession : public QObject { - Q_OBJECT - - public: - CoreSession(UserId, Storage *); - ~CoreSession(); - - QList buffers() const; - inline UserId userId(); - QVariant sessionState(); - CoreProxy *proxy(); - - public slots: - void connectToIrc(QStringList); - void processSignal(ClientSignal, QVariant, QVariant, QVariant); - void sendBacklog(BufferId, QVariant, QVariant); - void msgFromGui(BufferId, QString message); - void sendServerStates(); - - signals: - void proxySignal(CoreSignal, QVariant arg1 = QVariant(), QVariant arg2 = QVariant(), QVariant arg3 = QVariant()); - - void msgFromGui(QString net, QString buf, QString message); - void displayMsg(Message message); - void displayStatusMsg(QString, QString); - - void connectToIrc(QString net); - void disconnectFromIrc(QString net); - void serverStateRequested(); - - void backlogData(BufferId, QList, bool done); + 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); - void bufferIdUpdated(BufferId); + bool registerStorageBackend(Storage *); + void unregisterStorageBackend(Storage *); - private slots: - //void recvProxySignal(CoreSignal, QVariant arg1 = QVariant(), QVariant arg2 = QVariant(), QVariant arg3 = QVariant()); - void globalDataUpdated(UserId, QString); - void recvStatusMsgFromServer(QString msg); - void recvMessageFromServer(Message::Type, QString target, QString text, QString sender = "", quint8 flags = Message::None); - void serverConnected(QString net); - void serverDisconnected(QString net); - - private: - CoreProxy *coreProxy; + QHash sessions; Storage *storage; - QHash servers; - UserId user; - -}; - -/* -class Core : public QObject { - Q_OBJECT - - public: + QTimer _storageSyncTimer; - Core(); - ~Core(); - QList getBuffers(); - - public slots: - void connectToIrc(QStringList); - void sendBacklog(BufferId, QVariant, QVariant); - void msgFromGUI(BufferId, QString message); - - signals: - void msgFromGUI(QString net, QString buf, QString message); - void displayMsg(Message message); - void displayStatusMsg(QString, QString); +#ifdef HAVE_SSL + SslServer _server, _v6server; +#else + QTcpServer _server, _v6server; +#endif - void connectToIrc(QString net); - void disconnectFromIrc(QString net); - void serverStateRequested(); + QHash blocksizes; + QHash clientInfo; - void backlogData(BufferId, QList, bool done); + QHash _storageBackends; - void bufferIdUpdated(BufferId); + QDateTime _startTime; - private slots: - void globalDataUpdated(QString); - void recvStatusMsgFromServer(QString msg); - void recvMessageFromServer(Message::Type, QString target, QString text, QString sender = "", quint8 flags = Message::None); - void serverDisconnected(QString net); - - private: - Storage *storage; - QHash servers; - UserId user; + bool configured; + static QMutex mutex; }; -*/ -//extern Core *core; - - #endif