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