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