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