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