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