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