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