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