src/core/coresession.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2013 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 InternalPeer;
  45 class IrcParser;
  46 class Peer;
  47 class MessageEvent;
  48 class NetworkConnection;
  49 class RemotePeer;
  50 class SignalProxy;
  51
  52 struct NetworkInfo;
  53
  54 class QScriptEngine;
  55
  56 class CoreSession : public QObject
  57 {
  58     Q_OBJECT
  59
  60 public:
  61     CoreSession(UserId, bool restoreState, QObject *parent = 0);
  62     ~CoreSession();
  63
  64     QList<BufferInfo> buffers() const;
  65     inline UserId user() const { return _user; }
  66     CoreNetwork *network(NetworkId) const;
  67     CoreIdentity *identity(IdentityId) const;
  68     inline CoreNetworkConfig *networkConfig() const { return _networkConfig; }
  69     NetworkConnection *networkConnection(NetworkId) const;
  70
  71     QVariant sessionState();
  72
  73     inline SignalProxy *signalProxy() const { return _signalProxy; }
  74
  75     const AliasManager &aliasManager() const { return _aliasManager; }
  76     AliasManager &aliasManager() { return _aliasManager; }
  77
  78     inline EventManager *eventManager() const { return _eventManager; }
  79     inline EventStringifier *eventStringifier() const { return _eventStringifier; }
  80     inline CoreSessionEventProcessor *sessionEventProcessor() const { return _sessionEventProcessor; }
  81     inline CtcpParser *ctcpParser() const { return _ctcpParser; }
  82     inline IrcParser *ircParser() const { return _ircParser; }
  83
  84     inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
  85
  86     inline CoreIgnoreListManager *ignoreListManager() { return &_ignoreListManager; }
  87 //   void attachNetworkConnection(NetworkConnection *conn);
  88
  89     //! Return necessary data for restoring the session after restarting the core
  90     void restoreSessionState();
  91
  92 public slots:
  93     void addClient(RemotePeer *peer);
  94     void addClient(InternalPeer *peer);
  95
  96     void msgFromClient(BufferInfo, QString message);
  97
  98     //! Create an identity and propagate the changes to the clients.
  99     /** \param identity The identity to be created.
 100      */
 101     void createIdentity(const Identity &identity, const QVariantMap &additional);
 102     void createIdentity(const CoreIdentity &identity);
 103
 104     //! Remove identity and propagate that fact to the clients.
 105     /** \param identity The identity to be removed.
 106      */
 107     void removeIdentity(IdentityId identity);
 108
 109     //! Create a network and propagate the changes to the clients.
 110     /** \param info The network's settings.
 111      */
 112     void createNetwork(const NetworkInfo &info, const QStringList &persistentChannels = QStringList());
 113
 114     //! Remove network and propagate that fact to the clients.
 115     /** \param network The id of the network to be removed.
 116      */
 117     void removeNetwork(NetworkId network);
 118
 119     //! Rename a Buffer for a given network
 120     /* \param networkId The id of the network the buffer belongs to
 121      * \param newName   The new name of the buffer
 122      * \param oldName   The old name of the buffer
 123      */
 124     void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
 125
 126     QHash<QString, QString> persistentChannels(NetworkId) const;
 127
 128     //! Marks us away (or unaway) on all networks
 129     void globalAway(const QString &msg = QString());
 130
 131 signals:
 132     void initialized();
 133     void sessionState(const QVariant &);
 134
 135     //void msgFromGui(uint netid, QString buf, QString message);
 136     void displayMsg(Message message);
 137     void displayStatusMsg(QString, QString);
 138
 139     void scriptResult(QString result);
 140
 141     //! Identity has been created.
 142     /** This signal is propagated to the clients to tell them that the given identity has been created.
 143      *  \param identity The new identity.
 144      */
 145     void identityCreated(const Identity &identity);
 146
 147     //! Identity has been removed.
 148     /** This signal is propagated to the clients to inform them about the removal of the given identity.
 149      *  \param identity The identity that has been removed.
 150      */
 151     void identityRemoved(IdentityId identity);
 152
 153     void networkCreated(NetworkId);
 154     void networkRemoved(NetworkId);
 155     void networkDisconnected(NetworkId);
 156
 157 protected:
 158     virtual void customEvent(QEvent *event);
 159
 160 private slots:
 161     void removeClient(Peer *peer);
 162
 163     void recvStatusMsgFromServer(QString msg);
 164     void recvMessageFromServer(NetworkId networkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 165
 166     void destroyNetwork(NetworkId);
 167
 168     void scriptRequest(QString script);
 169
 170     void clientsConnected();
 171     void clientsDisconnected();
 172
 173     void updateIdentityBySender();
 174
 175     void saveSessionState() const;
 176
 177 private:
 178     void processMessages();
 179
 180     void loadSettings();
 181     void initScriptEngine();
 182
 183     /// Hook for converting events to the old displayMsg() handlers
 184     Q_INVOKABLE void processMessageEvent(MessageEvent *event);
 185
 186     UserId _user;
 187
 188     SignalProxy *_signalProxy;
 189     CoreAliasManager _aliasManager;
 190     // QHash<NetworkId, NetworkConnection *> _connections;
 191     QHash<NetworkId, CoreNetwork *> _networks;
 192     //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
 193     QHash<IdentityId, CoreIdentity *> _identities;
 194
 195     CoreBufferSyncer *_bufferSyncer;
 196     CoreBacklogManager *_backlogManager;
 197     CoreBufferViewManager *_bufferViewManager;
 198     CoreIrcListHelper *_ircListHelper;
 199     CoreNetworkConfig *_networkConfig;
 200     CoreCoreInfo _coreInfo;
 201
 202     EventManager *_eventManager;
 203     EventStringifier *_eventStringifier; // should eventually move into client
 204     CoreSessionEventProcessor *_sessionEventProcessor;
 205     CtcpParser *_ctcpParser;
 206     IrcParser *_ircParser;
 207
 208     QScriptEngine *scriptEngine;
 209
 210     QList<RawMessage> _messageQueue;
 211     bool _processMessages;
 212     CoreIgnoreListManager _ignoreListManager;
 213 };
 214
 215
 216 struct RawMessage {
 217     NetworkId networkId;
 218     Message::Type type;
 219     BufferInfo::Type bufferType;
 220     QString target;
 221     QString text;
 222     QString sender;
 223     Message::Flags flags;
 224     RawMessage(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender, Message::Flags flags)
 225         : networkId(networkId), type(type), bufferType(bufferType), target(target), text(text), sender(sender), flags(flags) {}
 226 };
 227
 228 #endif