src/core/coresession.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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 "message.h"
  28
  29 class BufferSyncer;
  30 class CoreBacklogManager;
  31 class CoreBufferViewManager;
  32 class CoreIrcListHelper;
  33 class Identity;
  34 class NetworkConnection;
  35 class CoreNetwork;
  36 struct NetworkInfo;
  37 class SignalProxy;
  38
  39 class QScriptEngine;
  40
  41 class CoreSession : public QObject {
  42   Q_OBJECT
  43
  44 public:
  45   CoreSession(UserId, bool restoreState, QObject *parent = 0);
  46   ~CoreSession();
  47
  48   QList<BufferInfo> buffers() const;
  49   UserId user() const;
  50   CoreNetwork *network(NetworkId) const;
  51   NetworkConnection *networkConnection(NetworkId) const;
  52   Identity *identity(IdentityId) const;
  53
  54   QVariant sessionState();
  55
  56   SignalProxy *signalProxy() const;
  57
  58   inline CoreIrcListHelper *ircListHelper() const { return _ircListHelper; }
  59
  60   void attachNetworkConnection(NetworkConnection *conn);
  61
  62   //! Return necessary data for restoring the session after restarting the core
  63   void saveSessionState() const;
  64   void restoreSessionState();
  65
  66 public slots:
  67   void networkStateRequested();
  68
  69   void addClient(QObject *socket);
  70
  71   void connectToNetwork(NetworkId);
  72   void disconnectFromNetwork(NetworkId id);
  73
  74   void msgFromClient(BufferInfo, QString message);
  75
  76   //! Create an identity and propagate the changes to the clients.
  77   /** \param identity The identity to be created.
  78    */
  79   void createIdentity(const Identity &identity);
  80
  81   //! Update an identity and propagate the changes to the clients.
  82   /** \param identity The identity to be updated.
  83    */
  84   void updateIdentity(const Identity &identity);
  85
  86   //! Remove identity and propagate that fact to the clients.
  87   /** \param identity The identity to be removed.
  88    */
  89   void removeIdentity(IdentityId identity);
  90
  91   //! Create a network and propagate the changes to the clients.
  92   /** \param info The network's settings.
  93    */
  94   void createNetwork(const NetworkInfo &info);
  95
  96   //! Update a network and propagate the changes to the clients.
  97   /** \param info The updated network settings.
  98    */
  99   void updateNetwork(const NetworkInfo &info);
 100
 101   //! Remove identity and propagate that fact to the clients.
 102   /** \param identity The identity to be removed.
 103    */
 104   void removeNetwork(NetworkId network);
 105
 106   //! Remove a buffer and it's backlog permanently
 107   /** \param bufferId The id of the buffer to be removed.
 108    *  emits bufferRemoved(bufferId) on success.
 109    */
 110   void removeBufferRequested(BufferId bufferId);
 111
 112   //! Rename a Buffer for a given network
 113   /* \param networkId The id of the network the buffer belongs to
 114    * \param newName   The new name of the buffer
 115    * \param oldName   The old name of the buffer
 116    * emits bufferRenamed(bufferId, newName) on success.
 117    */
 118   void renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName);
 119
 120   void channelJoined(NetworkId id, const QString &channel, const QString &key = QString());
 121   void channelParted(NetworkId, const QString &channel);
 122   QHash<QString, QString> persistentChannels(NetworkId) const;
 123
 124 signals:
 125   void initialized();
 126
 127   //void msgFromGui(uint netid, QString buf, QString message);
 128   void displayMsg(Message message);
 129   void displayStatusMsg(QString, QString);
 130
 131   //void connectToIrc(QString net);
 132   //void disconnectFromIrc(QString net);
 133
 134   void bufferInfoUpdated(BufferInfo);
 135
 136   void scriptResult(QString result);
 137
 138   //! Identity has been created.
 139   /** This signal is propagated to the clients to tell them that the given identity has been created.
 140    *  \param identity The new identity.
 141    */
 142   void identityCreated(const Identity &identity);
 143
 144   //! Identity has been removed.
 145   /** This signal is propagated to the clients to inform them about the removal of the given identity.
 146    *  \param identity The identity that has been removed.
 147    */
 148   void identityRemoved(IdentityId identity);
 149
 150   void networkCreated(NetworkId);
 151   void networkRemoved(NetworkId);
 152   void bufferRemoved(BufferId);
 153   void bufferRenamed(BufferId, QString);
 154
 155 private slots:
 156   void removeClient(QIODevice *dev);
 157
 158   void recvStatusMsgFromServer(QString msg);
 159   void recvMessageFromServer(Message::Type, BufferInfo::Type, QString target, QString text, QString sender = "", Message::Flags flags = Message::None);
 160   void networkConnected(NetworkId networkid);
 161   void networkDisconnected(NetworkId networkid);
 162
 163   void destroyNetwork(NetworkId);
 164
 165   //! Called when storage updated a BufferInfo.
 166   /** This emits bufferInfoUpdated() via SignalProxy, iff it's one of our buffers.
 167    *  \param user       The buffer's owner (not necessarily us)
 168    *  \param bufferInfo The updated BufferInfo
 169    */
 170   void updateBufferInfo(UserId user, const BufferInfo &bufferInfo);
 171
 172   void storeBufferLastSeenMsg(BufferId buffer, const MsgId &msgId);
 173
 174   void scriptRequest(QString script);
 175
 176 private:
 177   void loadSettings();
 178   void initScriptEngine();
 179
 180   UserId _user;
 181
 182   SignalProxy *_signalProxy;
 183   QHash<NetworkId, NetworkConnection *> _connections;
 184   QHash<NetworkId, CoreNetwork *> _networks;
 185   //  QHash<NetworkId, CoreNetwork *> _networksToRemove;
 186   QHash<IdentityId, Identity *> _identities;
 187
 188   BufferSyncer *_bufferSyncer;
 189   CoreBacklogManager *_backlogManager;
 190   CoreBufferViewManager *_bufferViewManager;
 191   CoreIrcListHelper *_ircListHelper;
 192
 193   QScriptEngine *scriptEngine;
 194
 195 };
 196
 197 #endif