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 }
 148
 149 void Client::init() {
 150   blockSize = 0;
 151
 152   _bufferModel = new BufferTreeModel(this);
 153
 154   connect(this, SIGNAL(bufferSelected(Buffer *)),
 155           _bufferModel, SLOT(selectBuffer(Buffer *)));
 156   connect(this, SIGNAL(bufferUpdated(Buffer *)),
 157           _bufferModel, SLOT(bufferUpdated(Buffer *)));
 158   connect(this, SIGNAL(bufferActivity(Buffer::ActivityLevel, Buffer *)),
 159           _bufferModel, SLOT(bufferActivity(Buffer::ActivityLevel, Buffer *)));
 160
 161   SignalProxy *p = signalProxy();
 162   p->attachSignal(this, SIGNAL(sendSessionData(const QString &, const QVariant &)),
 163                   SIGNAL(clientSessionDataChanged(const QString &, const QVariant &)));
 164   p->attachSlot(SIGNAL(coreSessionDataChanged(const QString &, const QVariant &)),
 165                 this, SLOT(recvSessionData(const QString &, const QVariant &)));
 166   p->attachSlot(SIGNAL(coreState(const QVariant &)),
 167                 this, SLOT(recvCoreState(const QVariant &)));
 168   p->attachSlot(SIGNAL(networkConnected(uint)),
 169                 this, SLOT(networkConnected(uint)));
 170   p->attachSlot(SIGNAL(networkDisconnected(uint)),
 171                 this, SLOT(networkDisconnected(uint)));
 172   p->attachSlot(SIGNAL(displayMsg(const Message &)),
 173                 this, SLOT(recvMessage(const Message &)));
 174   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)),
 175                 this, SLOT(recvStatusMsg(QString, QString)));
 176
 177
 178   p->attachSlot(SIGNAL(backlogData(BufferInfo, const QVariantList &, bool)), this, SLOT(recvBacklogData(BufferInfo, const QVariantList &, bool)));
 179   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), this, SLOT(updateBufferInfo(BufferInfo)));
 180   p->attachSignal(this, SIGNAL(sendInput(BufferInfo, QString)));
 181   p->attachSignal(this, SIGNAL(requestNetworkStates()));
 182
 183   connect(mainUi, SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
 184   connect(mainUi, SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
 185   connect(this, SIGNAL(connected()), mainUi, SLOT(connectedToCore()));
 186   connect(this, SIGNAL(disconnected()), mainUi, SLOT(disconnectedFromCore()));
 187
 188   layoutTimer = new QTimer(this);
 189   layoutTimer->setInterval(0);
 190   layoutTimer->setSingleShot(false);
 191   connect(layoutTimer, SIGNAL(timeout()), this, SLOT(layoutMsg()));
 192
 193 }
 194
 195 bool Client::isConnected() {
 196   return instance()->connectedToCore;
 197 }
 198
 199 void Client::connectToCore(const QVariantMap &conn) {
 200   // TODO implement SSL
 201   coreConnectionInfo = conn;
 202
 203   if(isConnected()) {
 204     emit coreConnectionError(tr("Already connected to Core!"));
 205     return;
 206   }
 207
 208   if(socket != 0)
 209     socket->deleteLater();
 210
 211   if(conn["Host"].toString().isEmpty()) {
 212     clientMode = LocalCore;
 213     socket = new QBuffer(this);
 214     connect(socket, SIGNAL(readyRead()), this, SLOT(coreHasData()));
 215     socket->open(QIODevice::ReadWrite);
 216     //QVariant state = connectToLocalCore(coreConnectionInfo["User"].toString(), coreConnectionInfo["Password"].toString());
 217     //syncToCore(state);
 218     coreSocketConnected();
 219   } else {
 220     clientMode = RemoteCore;
 221     emit coreConnectionMsg(tr("Connecting..."));
 222     Q_ASSERT(!socket);
 223     QTcpSocket *sock = new QTcpSocket(this);
 224     socket = sock;
 225     connect(sock, SIGNAL(readyRead()), this, SLOT(coreHasData()));
 226     connect(sock, SIGNAL(connected()), this, SLOT(coreSocketConnected()));
 227     connect(sock, SIGNAL(disconnected()), this, SLOT(coreSocketDisconnected()));
 228     connect(signalProxy(), SIGNAL(peerDisconnected()), this, SLOT(coreSocketDisconnected()));
 229     //connect(sock, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(coreSocketStateChanged(QAbstractSocket::SocketState)));
 230     connect(sock, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(coreSocketError(QAbstractSocket::SocketError)));
 231     sock->connectToHost(conn["Host"].toString(), conn["Port"].toUInt());
 232   }
 233 }
 234
 235 void Client::disconnectFromCore() {
 236   socket->close();
 237   if(clientMode == LocalCore)
 238     coreSocketDisconnected();
 239 }
 240
 241 void Client::coreSocketConnected() {
 242   connect(this, SIGNAL(recvPartialItem(uint, uint)), this, SIGNAL(coreConnectionProgress(uint, uint)));
 243   emit coreConnectionMsg(tr("Synchronizing to core..."));
 244   QVariantMap clientInit;
 245   clientInit["GuiProtocol"] = GUI_PROTOCOL;
 246   clientInit["User"] = coreConnectionInfo["User"].toString();
 247   clientInit["Password"] = coreConnectionInfo["Password"].toString();
 248   writeDataToDevice(socket, clientInit);
 249 }
 250
 251 void Client::coreSocketDisconnected() {
 252   instance()->connectedToCore = false;
 253   emit disconnected();
 254   socket->deleteLater();
 255   blockSize = 0;
 256
 257   /* Clear internal data. Hopefully nothing relies on it at this point. */
 258   _bufferModel->clear();
 259
 260   foreach(Buffer *buffer, _buffers.values()) {
 261     delete buffer;
 262   }
 263   Q_ASSERT(_buffers.empty());
 264
 265   foreach(NetworkInfo *networkinfo, _networkInfo.values()) {
 266     delete networkinfo;
 267   }
 268   Q_ASSERT(_networkinfo.empty());
 269
 270   coreConnectionInfo.clear();
 271   sessionData.clear();
 272   layoutQueue.clear();
 273   layoutTimer->stop();
 274 }
 275
 276 void Client::coreSocketStateChanged(QAbstractSocket::SocketState state) {
 277   if(state == QAbstractSocket::UnconnectedState) coreSocketDisconnected();
 278 }
 279
 280 void Client::recvCoreState(const QVariant &state) {
 281   disconnect(this, SIGNAL(recvPartialItem(uint, uint)), this, SIGNAL(coreConnectionProgress(uint, uint)));
 282   disconnect(socket, 0, this, 0);  // rest of communication happens through SignalProxy
 283   signalProxy()->addPeer(socket);
 284   syncToCore(state);
 285 }
 286
 287 // TODO: auth errors
 288 void Client::syncToCore(const QVariant &coreState) {
 289   if(!coreState.toMap().contains("SessionState")) {
 290     emit coreConnectionError(tr("Invalid data received from core!"));
 291     disconnectFromCore();
 292     return;
 293   }
 294
 295   QVariantMap sessionState = coreState.toMap()["SessionState"].toMap();
 296
 297   // store sessionData
 298   QVariantMap sessData = sessionState["SessionData"].toMap();
 299   foreach(QString key, sessData.keys())
 300     recvSessionData(key, sessData[key]);
 301
 302   // store Buffer details
 303   QVariantList coreBuffers = sessionState["Buffers"].toList();
 304   /* make lookups by id faster */
 305   foreach(QVariant vid, coreBuffers) {
 306     buffer(vid.value<BufferInfo>()); // create all buffers, so we see them in the network views
 307   }
 308
 309   // create networkInfo objects
 310   QVariantList networkids = sessionState["Networks"].toList();
 311   foreach(QVariant networkid, networkids) {
 312     networkConnected(networkid.toUInt());
 313   }
 314
 315   instance()->connectedToCore = true;
 316   updateCoreConnectionProgress();
 317 }
 318
 319 void Client::updateCoreConnectionProgress() {
 320   // we'll do this in three steps:
 321   // 1.) networks
 322   // 2.) channels
 323   // 3.) ircusers
 324
 325   int numNets = networkInfos().count();
 326   int numNetsWaiting = 0;
 327
 328   int numIrcUsers = 0;
 329   int numIrcUsersWaiting = 0;
 330
 331   int numChannels = 0;
 332   int numChannelsWaiting = 0;
 333
 334   foreach(NetworkInfo *net, networkInfos()) {
 335     if(! net->initialized())
 336       numNetsWaiting++;
 337
 338     numIrcUsers += net->ircUsers().count();
 339     foreach(IrcUser *user, net->ircUsers()) {
 340       if(! user->initialized())
 341         numIrcUsersWaiting++;
 342     }
 343
 344     numChannels += net->ircChannels().count();
 345     foreach(IrcChannel *channel, net->ircChannels()) {
 346       if(! channel->initialized())
 347         numChannelsWaiting++;
 348     }
 349
 350   }
 351
 352   if(numNetsWaiting > 0) {
 353     emit coreConnectionMsg(tr("Requesting network states..."));
 354     emit coreConnectionProgress(numNets - numNetsWaiting, numNets);
 355     return;
 356   }
 357
 358   if(numIrcUsersWaiting > 0) {
 359     emit coreConnectionMsg(tr("Requesting User states..."));
 360     emit coreConnectionProgress(numIrcUsers - numIrcUsersWaiting, numIrcUsers);
 361     return;
 362   }
 363
 364   if(numChannelsWaiting > 0) {
 365     emit coreConnectionMsg(tr("Requesting Channel states..."));
 366     emit coreConnectionProgress(numChannels - numChannelsWaiting, numChannels);
 367     return;
 368   }
 369
 370   emit coreConnectionProgress(1,1);
 371   emit connected();
 372 }
 373
 374 void Client::recvSessionData(const QString &key, const QVariant &data) {
 375   sessionData[key] = data;
 376   emit sessionDataChanged(key, data);
 377   emit sessionDataChanged(key);
 378 }
 379
 380 void Client::storeSessionData(const QString &key, const QVariant &data) {
 381   // Not sure if this is a good idea, but we'll try it anyway:
 382   // Calling this function only sends a signal to core. Data is stored upon reception of the update signal,
 383   // rather than immediately.
 384   emit instance()->sendSessionData(key, data);
 385 }
 386
 387 QVariant Client::retrieveSessionData(const QString &key, const QVariant &def) {
 388   if(instance()->sessionData.contains(key)) return instance()->sessionData[key];
 389   else return def;
 390 }
 391
 392 QStringList Client::sessionDataKeys() {
 393   return instance()->sessionData.keys();
 394 }
 395
 396 void Client::coreSocketError(QAbstractSocket::SocketError) {
 397   emit coreConnectionError(socket->errorString());
 398   socket->deleteLater();
 399 }
 400
 401 void Client::coreHasData() {
 402   QVariant item;
 403   if(readDataFromDevice(socket, blockSize, item)) {
 404     emit recvPartialItem(1,1);
 405     recvCoreState(item);
 406     blockSize = 0;
 407     return;
 408   }
 409   if(blockSize > 0) {
 410     emit recvPartialItem(socket->bytesAvailable(), blockSize);
 411   }
 412 }
 413
 414 void Client::networkConnected(uint netid) {
 415   // TODO: create statusBuffer / switch to networkids
 416   //BufferInfo id = statusBufferInfo(net);
 417   //Buffer *b = buffer(id);
 418   //b->setActive(true);
 419
 420   NetworkInfo *netinfo = new NetworkInfo(netid, signalProxy(), this);
 421   connect(netinfo, SIGNAL(initDone()), this, SLOT(updateCoreConnectionProgress()));
 422   connect(netinfo, SIGNAL(ircUserInitDone()), this, SLOT(updateCoreConnectionProgress()));
 423   connect(netinfo, SIGNAL(ircChannelInitDone()), this, SLOT(updateCoreConnectionProgress()));
 424   _networkInfo[netid] = netinfo;
 425 }
 426
 427 void Client::networkDisconnected(uint networkid) {
 428   foreach(Buffer *buffer, buffers()) {
 429     if(buffer->bufferInfo().networkId() != networkid)
 430       continue;
 431
 432     //buffer->displayMsg(Message(bufferid, Message::Server, tr("Server disconnected."))); FIXME
 433     buffer->setActive(false);
 434   }
 435
 436   Q_ASSERT(networkInfo(networkid));
 437   if(!networkInfo(networkid)->initialized()) {
 438     qDebug() << "Network" << networkid << "disconnected while not yet initialized!";
 439     updateCoreConnectionProgress();
 440   }
 441 }
 442
 443 void Client::updateBufferInfo(BufferInfo id) {
 444   buffer(id)->updateBufferInfo(id);
 445 }
 446
 447
 448 void Client::removeBuffer(Buffer *b) {
 449   _buffers.remove(b->bufferInfo().uid());
 450 }
 451
 452 void Client::recvMessage(const Message &msg) {
 453   Buffer *b = buffer(msg.buffer());
 454
 455   Buffer::ActivityLevel level = Buffer::OtherActivity;
 456   if(msg.type() == Message::Plain || msg.type() == Message::Notice){
 457     level |= Buffer::NewMessage;
 458   }
 459   if(msg.flags() & Message::Highlight){
 460     level |= Buffer::Highlight;
 461   }
 462   emit bufferActivity(level, b);
 463
 464   b->appendMsg(msg);
 465 }
 466
 467 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
 468   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
 469 }
 470
 471 void Client::recvBacklogData(BufferInfo id, QVariantList msgs, bool /*done*/) {
 472   Buffer *b = buffer(id);
 473   foreach(QVariant v, msgs) {
 474     Message msg = v.value<Message>();
 475     b->prependMsg(msg);
 476     if(!layoutQueue.contains(b)) layoutQueue.append(b);
 477   }
 478   if(layoutQueue.count() && !layoutTimer->isActive()) layoutTimer->start();
 479 }
 480
 481 void Client::layoutMsg() {
 482   if(layoutQueue.count()) {
 483     Buffer *b = layoutQueue.takeFirst();  // TODO make this the current buffer
 484     if(b->layoutMsg())
 485       layoutQueue.append(b);  // Buffer has more messages in its queue --> Round Robin
 486   }
 487
 488   if(!layoutQueue.count())
 489     layoutTimer->stop();
 490 }
 491
 492 AbstractUiMsg *Client::layoutMsg(const Message &msg) {
 493   return instance()->mainUi->layoutMsg(msg);
 494 }
 495
 496 void Client::userInput(BufferInfo id, QString msg) {
 497   emit sendInput(id, msg);
 498 }
 499