src/core/coresession.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef CORESESSION_H
  22 #define CORESESSION_H
  23
  24 #include <QString>
  25 #include <QVariant>
  26
  27 #include "corecoreinfo.h"
  28 #include "corealiasmanager.h"
  29 #include "coreignorelistmanager.h"
  30 #include "message.h"
  31 #include "storage.h"
  32
  33 class CoreBacklogManager;
  34 class CoreBufferSyncer;
  35 class CoreBufferViewManager;
  36 class CoreIdentity;
  37 class CoreIrcListHelper;
  38 class CoreNetwork;
  39 class CoreNetworkConfig;
  40 class CoreSessionEventProcessor;
  41 class CtcpParser;
  42 class EventManager;
  43 class EventStringifier;
  44 class IrcParser;
  45 class MessageEvent;
  46 class NetworkConnection;
  47 class SignalProxy;
  48
  49 struct NetworkInfo;
  50
  51 class QScriptEngine;
  52
  53 class CoreSession : public QObject
  54 {
  55     Q_OBJECT
  56
  57 public:
  58     CoreSession(UserId, bool restoreState, QObject *parent = 0);
  59     ~CoreSession();
  60
  61     QList<BufferInfo> buffers() const;
  62     inline UserId user() const { return _user; }
  63     CoreNetwork *network(NetworkId) const;
  64     CoreIdentity *identity(IdentityId) const;
  65     inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
  66     NetworkConnection *networkConnection(NetworkId) const;
  67
  68     QVariant sessionState();
  69
  70     inline SignalProxy *signalProxy() const { return _signalProxy; }
  71
  72     const AliasManager &aliasManager() const { return _aliasManager; }
  73     AliasManager &aliasManager() { return _aliasManager; }
  74
  75     inline EventManager *eventManager() const { return _eventManager; }
  76     inline EventStringifier *eventStringifier() const { return _eventStringifier; }
  77     inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
  78     inline CtcpParser *ctcpParser() const { return _ctcpParser; }
  79     inline IrcParser *ircParser() const { return _ircParser; }
  80
  81     inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
  82
  83     inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
  84 //   void attachNetworkConnection(NetworkConnection *conn);
  85
  86     //! Return necessary data for restoring the session after restarting the core
  87     void restoreSessionState();
  88
  89 public slots:
  90     void addClient(QIODevice *device);
  91     void addClient(SignalProxy *proxy);
  92
  93     void msgFromClient(BufferInfo, QString message);
  94
  95     //! Create an identity and propagate the changes to the clients.
  96     /** \param identity The identity to be created.
  97      */
  98     void createIdentity(const Identity &identity, const QVariantMap &additional);
  99     void createIdentity(const CoreIdentity &identity);
 100
 101     //! Remove identity and propagate that fact to the clients.
 102     /** \param identity The identity to be removed.
 103      */
 104     void removeIdentity(IdentityId identity);
 105
 106     //! Create a network and propagate the changes to the clients.
 107     /** \param info The network's settings.
 108      */
 109     void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
 110
 111     //! Remove network and propagate that fact to the clients.
 112     /** \param network The id of the network to be removed.
 113      */
 114     void removeNetwork(NetworkId network);
 115
 116     //! Rename a Buffer for a given network
 117     /* \param networkId The id of the network the buffer belongs to
 118      * \param newName   The new name of the buffer
 119      * \param oldName   The old name of the buffer
 120      */
 121     void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
 122
 123     QHash<QString, QString> persistentChannels(NetworkId) const;
 124
 125     //! Marks us away (or unaway) on all networks
 126     void globalAway(const QString &msg = QString());
 127
 128 signals:
 129     void initialized();
 130     void sessionState(const QVariant &);
 131
 132     //void msgFromGui(uint netid, QString buf, QString message);
 133     void displayMsg(Message message);
 134     void displayStatusMsg(QString, QString);
 135
 136     void scriptResult(QString result);
 137
 138     //! Identity has been created.
 139     /** This signal is propagated to the clients to tell them that the given identity has been created.
 140      *  \param identity The new identity.
 141      */
 142     void identityCreated(const Identity &identity);
 143
 144     //! Identity has been removed.
 145     /** This signal is propagated to the clients to inform them about the removal of the given identity.
 146      *  \param identity The identity that has been removed.
 147      */
 148     void identityRemoved(IdentityId identity);
 149
 150     void networkCreated(NetworkId);
 151     void networkRemoved(NetworkId);
 152     void networkDisconnected(NetworkId);
 153
 154 protected:
 155     virtual void customEvent(QEvent *event);
 156
 157 private slots:
 158     void removeClient(QIODevice *dev);
 159
 160     void recvStatusMsgFromServer(QString msg);
 161     void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 162
 163     void destroyNetwork(NetworkId);
 164
 165     void scriptRequest(QString script);
 166
 167     void clientsConnected();
 168     void clientsDisconnected();
 169
 170     void updateIdentityBySender();
 171
 172     void saveSessionState() const;
 173
 174 private:
 175     void processMessages();
 176
 177     void loadSettings();
 178     void initScriptEngine();
 179
 180     /// Hook for converting events to the old displayMsg() handlers
 181     Q_INVOKABLE void processMessageEvent(MessageEvent *event);
 182
 183     UserId _user;
 184
 185     SignalProxy *_signalProxy;
 186     CoreAliasManager _aliasManager;
 187     // QHash<NetworkId, NetworkConnection *> _connections;
 188     QHash<NetworkId, CoreNetwork *> _networks;
 189     //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
 190     QHash<IdentityId, CoreIdentity *> _identities;
 191
 192     CoreBufferSyncer *_bufferSyncer;
 193     CoreBacklogManager *_backlogManager;
 194     CoreBufferViewManager *_bufferViewManager;
 195     CoreIrcListHelper *_ircListHelper;
 196     CoreNetworkConfig *_networkConfig;
 197     CoreCoreInfo _coreInfo;
 198
 199     EventManager *_eventManager;
 200     EventStringifier *_eventStringifier; // should eventually move into client
 201     CoreSessionEventProcessor *_sessionEventProcessor;
 202     CtcpParser *_ctcpParser;
 203     IrcParser *_ircParser;
 204
 205     QScriptEngine *scriptEngine;
 206
 207     QList<RawMessage> _messageQueue;
 208     bool _processMessages;
 209     CoreIgnoreListManager _ignoreListManager;
 210 };
 211
 212
 213 struct RawMessage {
 214     NetworkId networkId;
 215     Message::Type type;
 216     BufferInfo::Type bufferType;
 217     QString target;
 218     QString text;
 219     QString sender;
 220     Message::Flags flags;
 221     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
 222         : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
 223 };
 224
 225 #endif