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