src/client/client.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 _CLIENT_H_
  22 #define _CLIENT_H_
  23
  24 #include <QAbstractSocket>
  25 #include <QTcpSocket>
  26 #include <QList>
  27 #include <QPointer>
  28
  29 #include "buffer.h" // needed for activity lvl
  30 class BufferInfo;
  31 class Message;
  32
  33 class Identity;
  34 class Network;
  35
  36
  37 class AbstractUi;
  38 class AbstractUiMsg;
  39 class NetworkModel;
  40 class BufferModel;
  41 class IrcUser;
  42 class IrcChannel;
  43 class NickModel;
  44 class SignalProxy;
  45
  46 class QTimer;
  47
  48
  49 class Client : public QObject {
  50   Q_OBJECT
  51
  52 public:
  53   static Client *instance();
  54   static void destroy();
  55   static void init(AbstractUi *);
  56
  57   static QList<BufferInfo> allBufferInfos();
  58   static QList<Buffer *> buffers();
  59   static Buffer *buffer(BufferId bufferUid);
  60   static Buffer *buffer(BufferInfo);
  61
  62   static QList<NetworkId> networkIds();
  63   static const Network * network(NetworkId);
  64
  65   static QList<IdentityId> identityIds();
  66   static const Identity * identity(IdentityId);
  67
  68   //! Request creation of an identity with the given data.
  69   /** The request will be sent to the core, and will be propagated back to all the clients
  70    *  with a new valid IdentityId.
  71    *  \param identity The identity template for the new identity. It does not need to have a valid ID.
  72    */
  73   static void createIdentity(const Identity &identity);
  74
  75   //! Request update of an identity with the given data.
  76   /** The request will be sent to the core, and will be propagated back to all the clients.
  77    *  \param identity The identity to be updated.
  78    */
  79   static void updateIdentity(const Identity &identity);
  80
  81   //! Request removal of the identity with the given ID from the core (and all the clients, of course).
  82   /** \param id The ID of the identity to be removed.
  83    */
  84   static void removeIdentity(IdentityId id);
  85
  86   static void addNetwork(NetworkId id);
  87   static void addNetwork(Network *);
  88
  89
  90   static NetworkModel *networkModel();
  91   static BufferModel *bufferModel();
  92   static NickModel *nickModel();
  93   static SignalProxy *signalProxy();
  94
  95   static AbstractUiMsg *layoutMsg(const Message &);
  96
  97   static bool isConnected();
  98   static bool isSynced();
  99
 100   static void userInput(BufferInfo bufferInfo, QString message);
 101
 102   static void storeSessionData(const QString &key, const QVariant &data);
 103   static QVariant retrieveSessionData(const QString &key, const QVariant &def = QVariant());
 104   static QStringList sessionDataKeys();
 105
 106   enum ClientMode { LocalCore, RemoteCore };
 107
 108 signals:
 109   void sendInput(BufferInfo, QString message);
 110   void showBuffer(Buffer *);
 111   void bufferUpdated(BufferInfo bufferInfo);
 112   void backlogReceived(Buffer *, QList<Message>);
 113   void requestBacklog(BufferInfo, QVariant, QVariant);
 114   void requestNetworkStates();
 115
 116   void showConfigWizard(const QVariantMap &coredata);
 117
 118   void connected();
 119   void disconnected();
 120   void coreConnectionStateChanged(bool);
 121
 122   void sessionDataChanged(const QString &key);
 123   void sessionDataChanged(const QString &key, const QVariant &data);
 124   void sendSessionData(const QString &key, const QVariant &data);
 125
 126   //! The identity with the given ID has been newly created in core and client.
 127   /** \param id The ID of the newly created identity.
 128    */
 129   void identityCreated(IdentityId id);
 130
 131   //! The identity with the given ID has been removed.
 132   /** Upon emitting this signal, the identity is already gone from the core, and it will
 133    *  be deleted from the client immediately afterwards, so connected slots need to clean
 134    *  up their stuff.
 135    *  \param id The ID of the identity about to be removed.
 136    */
 137   void identityRemoved(IdentityId id);
 138
 139   //! Sent to the core when an identity shall be created. Should not be used elsewhere.
 140   void requestCreateIdentity(const Identity &);
 141   //! Sent to the core when an identity shall be updated. Should not be used elsewhere.
 142   void requestUpdateIdentity(const Identity &);
 143   //! Sent to the core when an identity shall be removed. Should not be used elsewhere.
 144   void requestRemoveIdentity(IdentityId);
 145
 146   void networkAdded(NetworkId id);
 147
 148 public slots:
 149   //void selectBuffer(Buffer *);
 150
 151   void setConnectedToCore(QIODevice *socket);
 152   void setSyncedToCore();
 153   void disconnectFromCore();
 154
 155   void setCoreConfiguration(const QVariantMap &settings);
 156
 157 private slots:
 158   void recvSessionData(const QString &key, const QVariant &data);
 159
 160   //void coreSocketError(QAbstractSocket::SocketError);
 161
 162   //void networkConnected(NetworkId);
 163   //void networkDisconnected(NetworkId);
 164
 165   void recvMessage(const Message &message);
 166   void recvStatusMsg(QString network, QString message);
 167   void recvBacklogData(BufferInfo, QVariantList, bool);
 168   void updateBufferInfo(BufferInfo);
 169
 170   void layoutMsg();
 171
 172   void bufferDestroyed();
 173   void networkDestroyed();
 174   void coreIdentityCreated(const Identity &);
 175   void coreIdentityRemoved(IdentityId);
 176
 177 private:
 178   Client(QObject *parent = 0);
 179   virtual ~Client();
 180   void init();
 181
 182   void syncToCore(const QVariantMap &sessionState);
 183
 184   static QPointer<Client> instanceptr;
 185
 186   QPointer<QIODevice> socket;
 187   QPointer<SignalProxy> _signalProxy;
 188   QPointer<AbstractUi> mainUi;
 189   QPointer<NetworkModel> _networkModel;
 190   QPointer<BufferModel> _bufferModel;
 191   QPointer<NickModel> _nickModel;
 192
 193   ClientMode clientMode;
 194
 195   bool _connectedToCore, _syncedToCore;
 196
 197   QHash<BufferId, Buffer *> _buffers;
 198   QHash<NetworkId, Network *> _networks;
 199   QHash<IdentityId, Identity *> _identities;
 200
 201   QTimer *layoutTimer;
 202   QList<Buffer *> layoutQueue;
 203
 204   QVariantMap sessionData;
 205
 206   friend class ClientSyncer;
 207 };
 208
 209 #endif