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