src/client/client.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-07 by The Quassel Team                             *
   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) any later version.                                   *
   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 #include "client.h"
  22
  23 #include "networkinfo.h"
  24 #include "ircuser.h"
  25 #include "ircchannel.h"
  26
  27 #include "message.h"
  28
  29 #include "bufferinfo.h"
  30 #include "buffertreemodel.h"
  31 #include "quasselui.h"
  32 #include "signalproxy.h"
  33 #include "synchronizer.h"
  34 #include "util.h"
  35
  36 QPointer<Client> Client::instanceptr = 0;
  37
  38 // ==============================
  39 //  public Static Methods
  40 // ==============================
  41 Client *Client::instance() {
  42   if(!instanceptr)
  43     instanceptr = new Client();
  44   return instanceptr;
  45 }
  46
  47 void Client::destroy() {
  48   delete instanceptr;
  49 }
  50
  51 void Client::init(AbstractUi *ui) {
  52   instance()->mainUi = ui;
  53   instance()->init();
  54 }
  55
  56 QList<NetworkInfo *> Client::networkInfos() {
  57   return instance()->_networkInfo.values();
  58 }
  59
  60 NetworkInfo *Client::networkInfo(uint networkid) {
  61   if(instance()->_networkInfo.contains(networkid))
  62     return instance()->_networkInfo[networkid];
  63   else
  64     return 0;
  65 }
  66
  67 QList<BufferInfo> Client::allBufferInfos() {
  68   QList<BufferInfo> bufferids;
  69   foreach(Buffer *buffer, buffers()) {
  70     bufferids << buffer->bufferInfo();
  71   }
  72   return bufferids;
  73 }
  74
  75 QList<Buffer *> Client::buffers() {
  76   return instance()->_buffers.values();
  77 }
  78
  79 Buffer *Client::buffer(uint bufferUid) {
  80   if(instance()->_buffers.contains(bufferUid))
  81     return instance()->_buffers[bufferUid];
  82   else
  83     return 0;
  84 }
  85
  86 Buffer *Client::buffer(BufferInfo id) {
  87   Buffer *buff = buffer(id.uid());
  88
  89   if(!buff) {
  90     Client *client = Client::instance();
  91     Buffer *buff = new Buffer(id, client);
  92
  93     connect(buff, SIGNAL(userInput(BufferInfo, QString)),
  94             client, SLOT(userInput(BufferInfo, QString)));
  95     connect(buff, SIGNAL(bufferUpdated(Buffer *)),
  96             client, SIGNAL(bufferUpdated(Buffer *)));
  97     connect(buff, SIGNAL(bufferDestroyed(Buffer *)),
  98             client, SIGNAL(bufferDestroyed(Buffer *)));
  99     connect(buff, SIGNAL(bufferDestroyed(Buffer *)),
 100             client, SLOT(removeBuffer(Buffer *)));
 101
 102     client->_buffers[id.uid()] = buff;
 103     emit client->bufferUpdated(buff);
 104   }
 105
 106   return buff;
 107 }
 108
 109 // FIXME switch to netids!
 110 // WHEN IS THIS NEEDED ANYHOW!?
 111 BufferInfo Client::bufferInfo(QString net, QString buf) {
 112   foreach(Buffer *buffer_, buffers()) {
 113     BufferInfo bufferInfo = buffer_->bufferInfo();
 114     if(bufferInfo.network() == net && bufferInfo.buffer() == buf)
 115       return bufferInfo;
 116   }
 117   Q_ASSERT(false);  // should never happen!
 118   return BufferInfo();
 119 }
 120
 121 BufferInfo Client::statusBufferInfo(QString net) {
 122   return bufferInfo(net, "");
 123 }
 124
 125 BufferTreeModel *Client::bufferModel() {
 126   return instance()->_bufferModel;
 127 }
 128
 129 SignalProxy *Client::signalProxy() {
 130   return instance()->_signalProxy;
 131 }
 132
 133 // ==============================
 134 //  Constructor / Decon
 135 // ==============================
 136 Client::Client(QObject *parent)
 137   : QObject(parent),
 138     socket(0),
 139     _signalProxy(new SignalProxy(SignalProxy::Client, 0, this)),
 140     mainUi(0),
 141     _bufferModel(0),
 142     connectedToCore(false)
 143 {
 144 }
 145
 146 Client::~Client() {
 147 // since we're now the parent of buffers this should be no longer needed
 148
 149 //   foreach(Buffer *buf, buffers.values()) delete buf; // this is done by disconnectFromCore()! FIXME?
 150 //   Q_ASSERT(!buffers.count());
 151 }
 152
 153 void Client::init() {
 154   blockSize = 0;
 155
 156   _bufferModel = new BufferTreeModel(this);
 157
 158   connect(this, SIGNAL(bufferSelected(Buffer *)),
 159           _bufferModel, SLOT(selectBuffer(Buffer *)));
 160   connect(this, SIGNAL(bufferUpdated(Buffer *)),
 161           _bufferModel, SLOT(bufferUpdated(Buffer *)));
 162   connect(this, SIGNAL(bufferActivity(Buffer::ActivityLevel, Buffer *)),
 163           _bufferModel, SLOT(bufferActivity(Buffer::ActivityLevel, Buffer *)));
 164
 165   SignalProxy *p = signalProxy();
 166   p->attachSignal(this, SIGNAL(sendSessionData(const QString &, const QVariant &)),
 167                   SIGNAL(clientSessionDataChanged(const QString &, const QVariant &)));
 168   p->attachSlot(SIGNAL(coreSessionDataChanged(const QString &, const QVariant &)),
 169                 this, SLOT(recvSessionData(const QString &, const QVariant &)));
 170   p->attachSlot(SIGNAL(coreState(const QVariant &)),
 171                 this, SLOT(recvCoreState(const QVariant &)));
 172   p->attachSlot(SIGNAL(networkConnected(uint)),
 173                 this, SLOT(networkConnected(uint)));
 174   p->attachSlot(SIGNAL(networkDisconnected(uint)),
 175                 this, SLOT(networkDisconnected(uint)));
 176   p->attachSlot(SIGNAL(displayMsg(const Message &)),
 177                 this, SLOT(recvMessage(const Message &)));
 178   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)),
 179                 this, SLOT(recvStatusMsg(QString, QString)));
 180
 181
 182   p->attachSlot(SIGNAL(backlogData(BufferInfo, const QVariantList &, bool)), this, SLOT(recvBacklogData(BufferInfo, const QVariantList &, bool)));
 183   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), this, SLOT(updateBufferInfo(BufferInfo)));
 184   p->attachSignal(this, SIGNAL(sendInput(BufferInfo, QString)));
 185   p->attachSignal(this, SIGNAL(requestNetworkStates()));
 186
 187   connect(mainUi, SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
 188   connect(mainUi, SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
 189   connect(this, SIGNAL(connected()), mainUi, SLOT(connectedToCore()));
 190   connect(this, SIGNAL(disconnected()), mainUi, SLOT(disconnectedFromCore()));
 191
 192   layoutTimer = new QTimer(this);
 193   layoutTimer->setInterval(0);
 194   layoutTimer->setSingleShot(false);
 195   connect(layoutTimer, SIGNAL(timeout()), this, SLOT(layoutMsg()));
 196
 197 }
 198
 199 bool Client::isConnected() {
 200   return instance()->connectedToCore;
 201 }
 202
 203 void Client::connectToCore(const QVariantMap &conn) {
 204   // TODO implement SSL
 205   coreConnectionInfo = conn;
 206
 207   if(isConnected()) {
 208     emit coreConnectionError(tr("Already connected to Core!"));
 209     return;
 210   }
 211
 212   if(socket != 0)
 213     socket->deleteLater();
 214
 215   if(conn["Host"].toString().isEmpty()) {
 216     clientMode = LocalCore;
 217     socket = new QBuffer(this);
 218     connect(socket, SIGNAL(readyRead()), this, SLOT(coreHasData()));
 219     socket->open(QIODevice::ReadWrite);
 220     //QVariant state = connectToLocalCore(coreConnectionInfo["User"].toString(), coreConnectionInfo["Password"].toString());
 221     //syncToCore(state);
 222     coreSocketConnected();
 223   } else {
 224     clientMode = RemoteCore;
 225     emit coreConnectionMsg(tr("Connecting..."));
 226     Q_ASSERT(!socket);
 227     QTcpSocket *sock = new QTcpSocket(this);
 228     socket = sock;
 229     connect(sock, SIGNAL(readyRead()), this, SLOT(coreHasData()));
 230     connect(sock, SIGNAL(connected()), this, SLOT(coreSocketConnected()));
 231     connect(sock, SIGNAL(disconnected()), this, SLOT(coreSocketDisconnected()));
 232     connect(signalProxy(), SIGNAL(peerDisconnected()), this, SLOT(coreSocketDisconnected()));
 233     //connect(sock, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(coreSocketStateChanged(QAbstractSocket::SocketState)));
 234     connect(sock, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(coreSocketError(QAbstractSocket::SocketError)));
 235     sock->connectToHost(conn["Host"].toString(), conn["Port"].toUInt());
 236   }
 237 }
 238
 239 void Client::disconnectFromCore() {
 240   if(clientMode == RemoteCore) {
 241     socket->close();
 242     //QAbstractSocket *sock = qobject_cast<QAbstractSocket*>(socket);
 243     //Q_ASSERT(sock);
 244     //sock->disconnectFromHost();
 245   } else {
 246     socket->close();
 247     //disconnectFromLocalCore();
 248     coreSocketDisconnected();
 249   }
 250 }
 251
 252 void Client::coreSocketConnected() {
 253   connect(this, SIGNAL(recvPartialItem(uint, uint)), this, SIGNAL(coreConnectionProgress(uint, uint)));
 254   emit coreConnectionMsg(tr("Synchronizing to core..."));
 255   QVariantMap clientInit;
 256   clientInit["GuiProtocol"] = GUI_PROTOCOL;
 257   clientInit["User"] = coreConnectionInfo["User"].toString();
 258   clientInit["Password"] = coreConnectionInfo["Password"].toString();
 259   writeDataToDevice(socket, clientInit);
 260 }
 261
 262 void Client::coreSocketDisconnected() {
 263   instance()->connectedToCore = false;
 264   emit disconnected();
 265   socket->deleteLater();
 266   blockSize = 0;
 267
 268   /* Clear internal data. Hopefully nothing relies on it at this point. */
 269   _bufferModel->clear();
 270   // Buffers, if deleted, send a signal that causes their removal from buffers and bufferInfos.
 271   // So we cannot simply go through the array in a loop (or use qDeleteAll) for deletion...
 272   while(!_buffers.empty()) {
 273     delete _buffers.take(_buffers.keys()[0]);
 274   }
 275   Q_ASSERT(_buffers.empty());
 276
 277   while(!_networkInfo.empty()) {
 278     delete _networkInfo.take(_networkInfo.keys()[0]);
 279   }
 280
 281   coreConnectionInfo.clear();
 282   sessionData.clear();
 283   layoutQueue.clear();
 284   layoutTimer->stop();
 285 }
 286
 287 void Client::coreSocketStateChanged(QAbstractSocket::SocketState state) {
 288   if(state == QAbstractSocket::UnconnectedState) coreSocketDisconnected();
 289 }
 290
 291 void Client::recvCoreState(const QVariant &state) {
 292   disconnect(this, SIGNAL(recvPartialItem(uint, uint)), this, SIGNAL(coreConnectionProgress(uint, uint)));
 293   disconnect(socket, 0, this, 0);  // rest of communication happens through SignalProxy
 294   signalProxy()->addPeer(socket);
 295   syncToCore(state);
 296 }
 297
 298 // TODO: auth errors
 299 void Client::syncToCore(const QVariant &coreState) {
 300   if(!coreState.toMap().contains("SessionState")) {
 301     emit coreConnectionError(tr("Invalid data received from core!"));
 302     disconnectFromCore();
 303     return;
 304   }
 305
 306   QVariantMap sessionState = coreState.toMap()["SessionState"].toMap();
 307
 308   // store sessionData
 309   QVariantMap sessData = sessionState["SessionData"].toMap();
 310   foreach(QString key, sessData.keys())
 311     recvSessionData(key, sessData[key]);
 312
 313   // store Buffer details
 314   QVariantList coreBuffers = sessionState["Buffers"].toList();
 315   /* make lookups by id faster */
 316   foreach(QVariant vid, coreBuffers) {
 317     buffer(vid.value<BufferInfo>()); // create all buffers, so we see them in the network views
 318   }
 319
 320   // create networkInfo objects
 321   QVariantList networkids = sessionState["Networks"].toList();
 322   foreach(QVariant networkid, networkids) {
 323     networkConnected(networkid.toUInt());
 324   }
 325
 326   instance()->connectedToCore = true;
 327   updateCoreConnectionProgress();
 328 }
 329
 330 void Client::updateCoreConnectionProgress() {
 331   // we'll do this in three steps:
 332   // 1.) networks
 333   // 2.) channels
 334   // 3.) ircusers
 335
 336   int numNets = networkInfos().count();
 337   int numNetsWaiting = 0;
 338
 339   int numIrcUsers = 0;
 340   int numIrcUsersWaiting = 0;
 341
 342   int numChannels = 0;
 343   int numChannelsWaiting = 0;
 344
 345   foreach(NetworkInfo *net, networkInfos()) {
 346     if(not net->initialized())
 347       numNetsWaiting++;
 348
 349     numIrcUsers += net->ircUsers().count();
 350     foreach(IrcUser *user, net->ircUsers()) {
 351       if(not user->initialized())
 352         numIrcUsersWaiting++;
 353     }
 354
 355     numChannels += net->ircChannels().count();
 356     foreach(IrcChannel *channel, net->ircChannels()) {
 357       if(not channel->initialized())
 358         numChannelsWaiting++;
 359     }
 360
 361   }
 362
 363   if(numNetsWaiting > 0) {
 364     emit coreConnectionMsg(tr("Requesting network states..."));
 365     emit coreConnectionProgress(numNets - numNetsWaiting, numNets);
 366     return;
 367   }
 368
 369   if(numIrcUsersWaiting > 0) {
 370     emit coreConnectionMsg(tr("Requesting User states..."));
 371     emit coreConnectionProgress(numIrcUsers - numIrcUsersWaiting, numIrcUsers);
 372     return;
 373   }
 374
 375   if(numChannelsWaiting > 0) {
 376     emit coreConnectionMsg(tr("Requesting Channel states..."));
 377     emit coreConnectionProgress(numChannels - numChannelsWaiting, numChannels);
 378     return;
 379   }
 380
 381   emit coreConnectionProgress(1,1);
 382   emit connected();
 383 }
 384
 385 void Client::recvSessionData(const QString &key, const QVariant &data) {
 386   sessionData[key] = data;
 387   emit sessionDataChanged(key, data);
 388   emit sessionDataChanged(key);
 389 }
 390
 391 void Client::storeSessionData(const QString &key, const QVariant &data) {
 392   // Not sure if this is a good idea, but we'll try it anyway:
 393   // Calling this function only sends a signal to core. Data is stored upon reception of the update signal,
 394   // rather than immediately.
 395   emit instance()->sendSessionData(key, data);
 396 }
 397
 398 QVariant Client::retrieveSessionData(const QString &key, const QVariant &def) {
 399   if(instance()->sessionData.contains(key)) return instance()->sessionData[key];
 400   else return def;
 401 }
 402
 403 QStringList Client::sessionDataKeys() {
 404   return instance()->sessionData.keys();
 405 }
 406
 407 void Client::coreSocketError(QAbstractSocket::SocketError) {
 408   emit coreConnectionError(socket->errorString());
 409   socket->deleteLater();
 410 }
 411
 412 void Client::coreHasData() {
 413   QVariant item;
 414   if(readDataFromDevice(socket, blockSize, item)) {
 415     emit recvPartialItem(1,1);
 416     recvCoreState(item);
 417     blockSize = 0;
 418     return;
 419   }
 420   if(blockSize > 0) {
 421     emit recvPartialItem(socket->bytesAvailable(), blockSize);
 422   }
 423 }
 424
 425 void Client::networkConnected(uint netid) {
 426   // TODO: create statusBuffer / switch to networkids
 427   //BufferInfo id = statusBufferInfo(net);
 428   //Buffer *b = buffer(id);
 429   //b->setActive(true);
 430
 431   NetworkInfo *netinfo = new NetworkInfo(netid, signalProxy(), this);
 432   connect(netinfo, SIGNAL(initDone()), this, SLOT(updateCoreConnectionProgress()));
 433   connect(netinfo, SIGNAL(ircUserInitDone()), this, SLOT(updateCoreConnectionProgress()));
 434   connect(netinfo, SIGNAL(ircChannelInitDone()), this, SLOT(updateCoreConnectionProgress()));
 435   _networkInfo[netid] = netinfo;
 436 }
 437
 438 void Client::networkDisconnected(uint networkid) {
 439   foreach(Buffer *buffer, buffers()) {
 440     if(buffer->bufferInfo().networkId() != networkid)
 441       continue;
 442
 443     //buffer->displayMsg(Message(bufferid, Message::Server, tr("Server disconnected."))); FIXME
 444     buffer->setActive(false);
 445   }
 446
 447   Q_ASSERT(networkInfo(networkid));
 448   if(!networkInfo(networkid)->initialized()) {
 449     qDebug() << "Network" << networkid << "disconnected while not yet initialized!";
 450     updateCoreConnectionProgress();
 451   }
 452 }
 453
 454 void Client::updateBufferInfo(BufferInfo id) {
 455   buffer(id)->updateBufferInfo(id);
 456 }
 457
 458
 459 void Client::removeBuffer(Buffer *b) {
 460   _buffers.remove(b->bufferInfo().uid());
 461 }
 462
 463 void Client::recvMessage(const Message &msg) {
 464   Buffer *b = buffer(msg.buffer());
 465
 466   Buffer::ActivityLevel level = Buffer::OtherActivity;
 467   if(msg.type() == Message::Plain || msg.type() == Message::Notice){
 468     level |= Buffer::NewMessage;
 469   }
 470   if(msg.flags() & Message::Highlight){
 471     level |= Buffer::Highlight;
 472   }
 473   emit bufferActivity(level, b);
 474
 475   b->appendMsg(msg);
 476 }
 477
 478 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
 479   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
 480 }
 481
 482 void Client::recvBacklogData(BufferInfo id, QVariantList msgs, bool /*done*/) {
 483   Buffer *b = buffer(id);
 484   foreach(QVariant v, msgs) {
 485     Message msg = v.value<Message>();
 486     b->prependMsg(msg);
 487     if(!layoutQueue.contains(b)) layoutQueue.append(b);
 488   }
 489   if(layoutQueue.count() && !layoutTimer->isActive()) layoutTimer->start();
 490 }
 491
 492 void Client::layoutMsg() {
 493   if(layoutQueue.count()) {
 494     Buffer *b = layoutQueue.takeFirst();  // TODO make this the current buffer
 495     if(b->layoutMsg())
 496       layoutQueue.append(b);  // Buffer has more messages in its queue --> Round Robin
 497   }
 498
 499   if(!layoutQueue.count())
 500     layoutTimer->stop();
 501 }
 502
 503 AbstractUiMsg *Client::layoutMsg(const Message &msg) {
 504   return instance()->mainUi->layoutMsg(msg);
 505 }
 506
 507 void Client::userInput(BufferInfo id, QString msg) {
 508   emit sendInput(id, msg);
 509 }
 510