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