Backlogdata is now made persistent every 10 minutes.
[quassel.git] / src / core / core.h
index aec0469..091c0f7 100644 (file)
@@ -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        *
 #ifndef _CORE_H_
 #define _CORE_H_
 
+#include <QDateTime>
+#include <QMutex>
 #include <QString>
 #include <QVariant>
-#include <QSqlDatabase>
+#include <QTimer>
+#include <QTcpServer>
+#include <QTcpSocket>
 
-#include "server.h"
-#include "storage.h"
+#include "bufferinfo.h"
+#include "message.h"
 #include "global.h"
-#include "coreproxy.h"
+#include "sessionthread.h"
+#include "types.h"
 
 class CoreSession;
+class SessionThread;
+class Storage;
+struct NetworkInfo;
 
 class Core : public QObject {
   Q_OBJECT
@@ -39,21 +47,108 @@ 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();
 
-    static QVariant connectLocalClient(QString user, QString passwd);
-    static QVariant disconnectLocalClient();
+    /*** 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<Message> 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<Message> 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<Message> 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<BufferInfo> 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:
-    void recvProxySignal(CoreSignal, QVariant, QVariant, QVariant);
-    bool startListening(uint port = 4242);
+    bool startListening(uint port = Global::defaultPort);
     void stopListening();
     void incomingConnection();
     void clientHasData();
     void clientDisconnected();
-    void updateGlobalData(UserId, QString);
+
+    bool initStorage(QVariantMap dbSettings, bool setup = false);
 
   private:
     Core();
@@ -61,118 +156,26 @@ class Core : public QObject {
     void init();
     static Core *instanceptr;
 
-    //! Initiate a session for the user with the given credentials if one does not already exist.
-    /** This function is called during the init process for a new client. If there is no session for the
-     *  given user, one is created.
-     * \param userId The user
-     * \return A QVariant containing the session data, e.g. global data and buffers
-     */
-    QVariant initSession(UserId userId);
-    void processClientInit(QTcpSocket *socket, const QVariant &v);
-    void processClientUpdate(QTcpSocket *socket, QString key, const QVariant &data);
+    SessionThread *createSession(UserId userId, bool restoreState = false);
+    void setupClientSession(QTcpSocket *socket, UserId uid);
+    void processCoreSetup(QTcpSocket *socket, QVariantMap &msg);
+
+    QStringList availableStorageProviders();
 
     UserId guiUser;
-    QHash<UserId, CoreSession *> sessions;
+    QHash<UserId, SessionThread *> sessions;
     Storage *storage;
+    QTimer _storageSyncTimer;
 
     QTcpServer server; // TODO: implement SSL
-    QHash<QTcpSocket *, UserId> validClients;
-    QHash<QTcpSocket *, quint32> blockSizes;
-};
-
-class CoreSession : public QObject {
-  Q_OBJECT
-
-  public:
-    CoreSession(UserId, Storage *);
-    ~CoreSession();
-
-    QList<BufferId> 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();
+    QHash<QTcpSocket *, quint32> blocksizes;
+    QHash<QTcpSocket *, QVariantMap> clientInfo;
 
-    void backlogData(BufferId, QList<QVariant>, bool done);
+    QDateTime startTime;
 
-    void bufferIdUpdated(BufferId);
-
-  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;
-    Storage *storage;
-    QHash<QString, Server *> servers;
-    UserId user;
+    bool configured;
 
+    static QMutex mutex;
 };
 
-/*
-class Core : public QObject {
-  Q_OBJECT
-
-  public:
-
-    Core();
-    ~Core();
-    QList<BufferId> 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);
-
-    void connectToIrc(QString net);
-    void disconnectFromIrc(QString net);
-    void serverStateRequested();
-
-    void backlogData(BufferId, QList<QVariant>, bool done);
-
-    void bufferIdUpdated(BufferId);
-
-  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<QString, Server *> servers;
-    UserId user;
-
-};
-
-*/
-//extern Core *core;
-
-
 #endif