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