src/client/client.cpp

   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 #include "client.h"
  22
  23 #include "bufferinfo.h"
  24 #include "buffermodel.h"
  25 #include "buffersettings.h"
  26 #include "buffersyncer.h"
  27 #include "bufferviewmanager.h"
  28 #include "clientbacklogmanager.h"
  29 #include "clientirclisthelper.h"
  30 #include "global.h"
  31 #include "identity.h"
  32 #include "ircchannel.h"
  33 #include "ircuser.h"
  34 #include "message.h"
  35 #include "messagemodel.h"
  36 #include "network.h"
  37 #include "networkmodel.h"
  38 #include "quasselui.h"
  39 #include "signalproxy.h"
  40 #include "util.h"
  41
  42 QPointer<Client> Client::instanceptr = 0;
  43 AccountId Client::_currentCoreAccount = 0;
  44
  45 /*** Initialization/destruction ***/
  46
  47 Client *Client::instance() {
  48   if(!instanceptr)
  49     instanceptr = new Client();
  50   return instanceptr;
  51 }
  52
  53 void Client::destroy() {
  54   //delete instanceptr;
  55   instanceptr->deleteLater();
  56 }
  57
  58 void Client::init(AbstractUi *ui) {
  59   instance()->mainUi = ui;
  60   instance()->init();
  61 }
  62
  63 Client::Client(QObject *parent)
  64   : QObject(parent),
  65     socket(0),
  66     _signalProxy(new SignalProxy(SignalProxy::Client, this)),
  67     mainUi(0),
  68     _networkModel(0),
  69     _bufferModel(0),
  70     _bufferSyncer(0),
  71     _backlogManager(new ClientBacklogManager(this)),
  72     _bufferViewManager(0),
  73     _ircListHelper(new ClientIrcListHelper(this)),
  74     _messageModel(0),
  75     _connectedToCore(false),
  76     _syncedToCore(false)
  77 {
  78   _monitorBuffer = new Buffer(BufferInfo(), this);
  79   _signalProxy->synchronize(_ircListHelper);
  80
  81   connect(_backlogManager, SIGNAL(backlog(BufferId, const QVariantList &)),
  82           this, SLOT(receiveBacklog(BufferId, const QVariantList &)));
  83 }
  84
  85 Client::~Client() {
  86   disconnectFromCore();
  87 }
  88
  89 void Client::init() {
  90   _currentCoreAccount = 0;
  91   _networkModel = new NetworkModel(this);
  92
  93   connect(this, SIGNAL(bufferUpdated(BufferInfo)),
  94           _networkModel, SLOT(bufferUpdated(BufferInfo)));
  95   connect(this, SIGNAL(networkRemoved(NetworkId)),
  96           _networkModel, SLOT(networkRemoved(NetworkId)));
  97
  98   _bufferModel = new BufferModel(_networkModel);
  99   _messageModel = mainUi->createMessageModel(this);
 100
 101   SignalProxy *p = signalProxy();
 102
 103   p->attachSlot(SIGNAL(displayMsg(const Message &)), this, SLOT(recvMessage(const Message &)));
 104   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)), this, SLOT(recvStatusMsg(QString, QString)));
 105
 106   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), this, SLOT(updateBufferInfo(BufferInfo)));
 107   p->attachSignal(this, SIGNAL(sendInput(BufferInfo, QString)));
 108   p->attachSignal(this, SIGNAL(requestNetworkStates()));
 109
 110   p->attachSignal(this, SIGNAL(requestCreateIdentity(const Identity &)), SIGNAL(createIdentity(const Identity &)));
 111   p->attachSignal(this, SIGNAL(requestUpdateIdentity(const Identity &)), SIGNAL(updateIdentity(const Identity &)));
 112   p->attachSignal(this, SIGNAL(requestRemoveIdentity(IdentityId)), SIGNAL(removeIdentity(IdentityId)));
 113   p->attachSlot(SIGNAL(identityCreated(const Identity &)), this, SLOT(coreIdentityCreated(const Identity &)));
 114   p->attachSlot(SIGNAL(identityRemoved(IdentityId)), this, SLOT(coreIdentityRemoved(IdentityId)));
 115
 116   p->attachSignal(this, SIGNAL(requestCreateNetwork(const NetworkInfo &)), SIGNAL(createNetwork(const NetworkInfo &)));
 117   p->attachSignal(this, SIGNAL(requestUpdateNetwork(const NetworkInfo &)), SIGNAL(updateNetwork(const NetworkInfo &)));
 118   p->attachSignal(this, SIGNAL(requestRemoveNetwork(NetworkId)), SIGNAL(removeNetwork(NetworkId)));
 119   p->attachSlot(SIGNAL(networkCreated(NetworkId)), this, SLOT(coreNetworkCreated(NetworkId)));
 120   p->attachSlot(SIGNAL(networkRemoved(NetworkId)), this, SLOT(coreNetworkRemoved(NetworkId)));
 121
 122   connect(p, SIGNAL(disconnected()), this, SLOT(disconnectFromCore()));
 123
 124   //connect(mainUi, SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
 125   connect(mainUi, SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
 126   connect(this, SIGNAL(connected()), mainUi, SLOT(connectedToCore()));
 127   connect(this, SIGNAL(disconnected()), mainUi, SLOT(disconnectedFromCore()));
 128
 129   layoutTimer = new QTimer(this);
 130   layoutTimer->setInterval(0);
 131   layoutTimer->setSingleShot(false);
 132   connect(layoutTimer, SIGNAL(timeout()), this, SLOT(layoutMsg()));
 133
 134 }
 135
 136 /*** public static methods ***/
 137
 138 AccountId Client::currentCoreAccount() {
 139   return _currentCoreAccount;
 140 }
 141
 142 void Client::setCurrentCoreAccount(AccountId id) {
 143   _currentCoreAccount = id;
 144 }
 145
 146 QList<BufferInfo> Client::allBufferInfos() {
 147   QList<BufferInfo> bufferids;
 148   foreach(Buffer *buffer, buffers()) {
 149     bufferids << buffer->bufferInfo();
 150   }
 151   return bufferids;
 152 }
 153
 154 QList<Buffer *> Client::buffers() {
 155   return instance()->_buffers.values();
 156 }
 157
 158
 159 Buffer *Client::statusBuffer(const NetworkId &networkId) const {
 160   if(_statusBuffers.contains(networkId))
 161     return _statusBuffers[networkId];
 162   else
 163     return 0;
 164 }
 165
 166 Buffer *Client::buffer(BufferId bufferId) {
 167   if(instance()->_buffers.contains(bufferId))
 168     return instance()->_buffers[bufferId];
 169   else
 170     return 0;
 171 }
 172
 173 Buffer *Client::buffer(BufferInfo bufferInfo) {
 174   Buffer *buff = buffer(bufferInfo.bufferId());
 175
 176   if(!buff) {
 177     Client *client = Client::instance();
 178     buff = new Buffer(bufferInfo, client);
 179     connect(buff, SIGNAL(destroyed()), client, SLOT(bufferDestroyed()));
 180     client->_buffers[bufferInfo.bufferId()] = buff;
 181     if(bufferInfo.type() == BufferInfo::StatusBuffer)
 182       client->_statusBuffers[bufferInfo.networkId()] = buff;
 183
 184     emit client->bufferUpdated(bufferInfo);
 185
 186     // I don't like this: but currently there isn't really a prettier way:
 187     if(isSynced()) {  // this slows down syncing a lot, so disable it during sync
 188       QModelIndex bufferIdx = networkModel()->bufferIndex(bufferInfo.bufferId());
 189       bufferModel()->setCurrentIndex(bufferModel()->mapFromSource(bufferIdx));
 190     }
 191   }
 192   Q_ASSERT(buff);
 193   return buff;
 194 }
 195
 196 bool Client::isConnected() {
 197   return instance()->_connectedToCore;
 198 }
 199
 200 bool Client::isSynced() {
 201   return instance()->_syncedToCore;
 202 }
 203
 204 /*** Network handling ***/
 205
 206 QList<NetworkId> Client::networkIds() {
 207   return instance()->_networks.keys();
 208 }
 209
 210 const Network * Client::network(NetworkId networkid) {
 211   if(instance()->_networks.contains(networkid)) return instance()->_networks[networkid];
 212   else return 0;
 213 }
 214
 215 void Client::createNetwork(const NetworkInfo &info) {
 216   emit instance()->requestCreateNetwork(info);
 217 }
 218
 219 void Client::updateNetwork(const NetworkInfo &info) {
 220   emit instance()->requestUpdateNetwork(info);
 221 }
 222
 223 void Client::removeNetwork(NetworkId id) {
 224   emit instance()->requestRemoveNetwork(id);
 225 }
 226
 227 void Client::addNetwork(Network *net) {
 228   net->setProxy(signalProxy());
 229   signalProxy()->synchronize(net);
 230   networkModel()->attachNetwork(net);
 231   connect(net, SIGNAL(destroyed()), instance(), SLOT(networkDestroyed()));
 232   instance()->_networks[net->networkId()] = net;
 233   emit instance()->networkCreated(net->networkId());
 234 }
 235
 236 void Client::coreNetworkCreated(NetworkId id) {
 237   if(_networks.contains(id)) {
 238     qWarning() << "Creation of already existing network requested!";
 239     return;
 240   }
 241   Network *net = new Network(id, this);
 242   addNetwork(net);
 243 }
 244
 245 void Client::coreNetworkRemoved(NetworkId id) {
 246   if(!_networks.contains(id))
 247     return;
 248   Network *net = _networks.take(id);
 249   emit networkRemoved(net->networkId());
 250   net->deleteLater();
 251 }
 252
 253 /*** Identity handling ***/
 254
 255 QList<IdentityId> Client::identityIds() {
 256   return instance()->_identities.keys();
 257 }
 258
 259 const Identity * Client::identity(IdentityId id) {
 260   if(instance()->_identities.contains(id)) return instance()->_identities[id];
 261   else return 0;
 262 }
 263
 264 void Client::createIdentity(const Identity &id) {
 265   emit instance()->requestCreateIdentity(id);
 266 }
 267
 268 void Client::updateIdentity(const Identity &id) {
 269   emit instance()->requestUpdateIdentity(id);
 270 }
 271
 272 void Client::removeIdentity(IdentityId id) {
 273   emit instance()->requestRemoveIdentity(id);
 274 }
 275
 276 void Client::coreIdentityCreated(const Identity &other) {
 277   if(!_identities.contains(other.id())) {
 278     Identity *identity = new Identity(other, this);
 279     _identities[other.id()] = identity;
 280     identity->setInitialized();
 281     signalProxy()->synchronize(identity);
 282     emit identityCreated(other.id());
 283   } else {
 284     qWarning() << tr("Identity already exists in client!");
 285   }
 286 }
 287
 288 void Client::coreIdentityRemoved(IdentityId id) {
 289   if(_identities.contains(id)) {
 290     emit identityRemoved(id);
 291     Identity *i = _identities.take(id);
 292     i->deleteLater();
 293   }
 294 }
 295
 296 /***  ***/
 297 void Client::userInput(BufferInfo bufferInfo, QString message) {
 298   emit instance()->sendInput(bufferInfo, message);
 299 }
 300
 301 /*** core connection stuff ***/
 302
 303 void Client::setConnectedToCore(QIODevice *sock, AccountId id) {
 304   socket = sock;
 305   signalProxy()->addPeer(socket);
 306   _connectedToCore = true;
 307   setCurrentCoreAccount(id);
 308 }
 309
 310 void Client::setSyncedToCore() {
 311   // create buffersyncer
 312   Q_ASSERT(!_bufferSyncer);
 313   _bufferSyncer = new BufferSyncer(this);
 314   connect(bufferSyncer(), SIGNAL(lastSeenMsgSet(BufferId, MsgId)), this, SLOT(updateLastSeenMsg(BufferId, MsgId)));
 315   connect(bufferSyncer(), SIGNAL(bufferRemoved(BufferId)), this, SLOT(bufferRemoved(BufferId)));
 316   connect(bufferSyncer(), SIGNAL(bufferRenamed(BufferId, QString)), this, SLOT(bufferRenamed(BufferId, QString)));
 317   signalProxy()->synchronize(bufferSyncer());
 318
 319   // attach backlog manager
 320   signalProxy()->synchronize(backlogManager());
 321
 322   // create a new BufferViewManager
 323   _bufferViewManager = new BufferViewManager(signalProxy(), this);
 324
 325   _syncedToCore = true;
 326   emit connected();
 327   emit coreConnectionStateChanged(true);
 328 }
 329
 330 void Client::setSecuredConnection() {
 331   emit securedConnection();
 332 }
 333
 334 void Client::disconnectFromCore() {
 335   if(!isConnected())
 336     return;
 337   _connectedToCore = false;
 338
 339   if(socket) {
 340     socket->close();
 341     socket->deleteLater();
 342   }
 343   _syncedToCore = false;
 344   emit disconnected();
 345   emit coreConnectionStateChanged(false);
 346
 347   // Clear internal data. Hopefully nothing relies on it at this point.
 348   setCurrentCoreAccount(0);
 349
 350   if(_bufferSyncer) {
 351     _bufferSyncer->deleteLater();
 352     _bufferSyncer = 0;
 353   }
 354
 355   if(_bufferViewManager) {
 356     _bufferViewManager->deleteLater();
 357     _bufferViewManager = 0;
 358   }
 359
 360   _networkModel->clear();
 361
 362   QHash<BufferId, Buffer *>::iterator bufferIter =  _buffers.begin();
 363   while(bufferIter != _buffers.end()) {
 364     Buffer *buffer = bufferIter.value();
 365     disconnect(buffer, SIGNAL(destroyed()), this, 0);
 366     bufferIter = _buffers.erase(bufferIter);
 367     buffer->deleteLater();
 368   }
 369   Q_ASSERT(_buffers.isEmpty());
 370
 371   _statusBuffers.clear();
 372
 373   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
 374   while(netIter != _networks.end()) {
 375     Network *net = netIter.value();
 376     emit networkRemoved(net->networkId());
 377     disconnect(net, SIGNAL(destroyed()), this, 0);
 378     netIter = _networks.erase(netIter);
 379     net->deleteLater();
 380   }
 381   Q_ASSERT(_networks.isEmpty());
 382
 383   QHash<IdentityId, Identity*>::iterator idIter = _identities.begin();
 384   while(idIter != _identities.end()) {
 385     Identity *id = idIter.value();
 386     emit identityRemoved(id->id());
 387     idIter = _identities.erase(idIter);
 388     id->deleteLater();
 389   }
 390   Q_ASSERT(_identities.isEmpty());
 391
 392   layoutQueue.clear();
 393   layoutTimer->stop();
 394 }
 395
 396 void Client::setCoreConfiguration(const QVariantMap &settings) {
 397   SignalProxy::writeDataToDevice(socket, settings);
 398 }
 399
 400 /*** ***/
 401
 402 void Client::updateBufferInfo(BufferInfo id) {
 403   emit bufferUpdated(id);
 404 }
 405
 406 void Client::bufferDestroyed() {
 407   Buffer *buffer = static_cast<Buffer *>(sender());
 408   QHash<BufferId, Buffer *>::iterator iter = _buffers.begin();
 409   while(iter != _buffers.end()) {
 410     if(iter.value() == buffer) {
 411       iter = _buffers.erase(iter);
 412       break;
 413     }
 414     iter++;
 415   }
 416
 417   QHash<NetworkId, Buffer *>::iterator statusIter = _statusBuffers.begin();
 418   while(statusIter != _statusBuffers.end()) {
 419     if(statusIter.value() == buffer) {
 420       statusIter = _statusBuffers.erase(statusIter);
 421       break;
 422     }
 423     statusIter++;
 424   }
 425 }
 426
 427 void Client::networkDestroyed() {
 428   Network *net = static_cast<Network *>(sender());
 429   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
 430   while(netIter != _networks.end()) {
 431     if(*netIter == net) {
 432       netIter = _networks.erase(netIter);
 433       break;
 434     } else {
 435       netIter++;
 436     }
 437   }
 438 }
 439
 440 void Client::recvMessage(const Message &msg_) {
 441   Message msg = msg_;
 442   checkForHighlight(msg);
 443   _messageModel->insertMessage(msg);
 444   buffer(msg.bufferInfo())->updateActivityLevel(msg);
 445 }
 446
 447 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
 448   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
 449 }
 450
 451 void Client::receiveBacklog(BufferId bufferId, const QVariantList &msgs) {
 452   //QTime start = QTime::currentTime();
 453   foreach(QVariant v, msgs) {
 454     Message msg = v.value<Message>();
 455     checkForHighlight(msg);
 456     _messageModel->insertMessage(msg);
 457     buffer(msg.bufferInfo())->updateActivityLevel(msg);
 458   }
 459   //qDebug() << "processed" << msgs.count() << "backlog lines in" << start.msecsTo(QTime::currentTime());
 460 }
 461
 462 void Client::layoutMsg() {
 463   if(layoutQueue.isEmpty()) {
 464     layoutTimer->stop();
 465     return;
 466   }
 467
 468   Buffer *buffer = layoutQueue.takeFirst();
 469   if(buffer->layoutMsg()) {
 470     layoutQueue.append(buffer);  // Buffer has more messages in its queue --> Round Robin
 471     return;
 472   }
 473
 474   if(layoutQueue.isEmpty())
 475     layoutTimer->stop();
 476 }
 477
 478 AbstractUiMsg *Client::layoutMsg(const Message &msg) {
 479   return instance()->mainUi->layoutMsg(msg);
 480 }
 481
 482 // TODO optimize checkForHighlight
 483 void Client::checkForHighlight(Message &msg) {
 484   if(!((msg.type() & (Message::Plain | Message::Notice | Message::Action)) && !(msg.flags() & Message::Self)))
 485     return;
 486
 487   NotificationSettings notificationSettings;
 488   const Network *net = network(msg.bufferInfo().networkId());
 489   if(net && !net->myNick().isEmpty()) {
 490     QStringList nickList;
 491     if(notificationSettings.highlightNick() == NotificationSettings::CurrentNick) {
 492       nickList << net->myNick();
 493     } else if(notificationSettings.highlightNick() == NotificationSettings::AllNicks) {
 494       const Identity *myIdentity = identity(net->identity());
 495       if(myIdentity)
 496         nickList = myIdentity->nicks();
 497     }
 498     foreach(QString nickname, nickList) {
 499       QRegExp nickRegExp("^(.*\\W)?" + QRegExp::escape(nickname) + "(\\W.*)?$");
 500       if(nickRegExp.exactMatch(msg.contents())) {
 501         msg.setFlags(msg.flags() | Message::Highlight);
 502         return;
 503       }
 504     }
 505
 506     foreach(QVariant highlight, notificationSettings.highlightList()) {
 507       QVariantMap highlightRule = highlight.toMap();
 508       if(!highlightRule["enable"].toBool())
 509         continue;
 510       Qt::CaseSensitivity caseSensitivity = highlightRule["cs"].toBool() ? Qt::CaseSensitive : Qt::CaseInsensitive;
 511       QString name = highlightRule["name"].toString();
 512       QRegExp userRegExp;
 513       if(highlightRule["regex"].toBool()) {
 514         userRegExp = QRegExp(name, caseSensitivity);
 515       } else {
 516         userRegExp = QRegExp("^(.*\\W)?" + QRegExp::escape(name) + "(\\W.*)?$", caseSensitivity);
 517       }
 518       if(userRegExp.exactMatch(msg.contents())) {
 519         msg.setFlags(msg.flags() | Message::Highlight);
 520         return;
 521       }
 522     }
 523   }
 524 }
 525
 526 void Client::updateLastSeenMsg(BufferId id, const MsgId &msgId) {
 527   Buffer *b = buffer(id);
 528   if(!b) {
 529     qWarning() << "Client::updateLastSeen(): Unknown buffer" << id;
 530     return;
 531   }
 532   b->setLastSeenMsg(msgId);
 533 }
 534
 535 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
 536   if(!bufferSyncer())
 537     return;
 538   bufferSyncer()->requestSetLastSeenMsg(id, msgId);
 539 }
 540
 541 void Client::removeBuffer(BufferId id) {
 542   if(!bufferSyncer()) return;
 543   bufferSyncer()->requestRemoveBuffer(id);
 544 }
 545
 546 void Client::bufferRemoved(BufferId bufferId) {
 547   // first remove the buffer from hash. this prohibits further lastSeenUpdates
 548   Buffer *buff = 0;
 549   if(_buffers.contains(bufferId)) {
 550     buff = _buffers.take(bufferId);
 551     layoutQueue.removeAll(buff);
 552     disconnect(buff, 0, this, 0);
 553   }
 554
 555   // then we select a sane buffer (status buffer)
 556   /* we have to manually select a buffer because otherwise inconsitent changes
 557    * to the model might occur:
 558    * the result of a buffer removal triggers a change in the selection model.
 559    * the newly selected buffer might be a channel that hasn't been selected yet
 560    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
 561    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
 562    */
 563   QModelIndex current = bufferModel()->currentIndex();
 564   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
 565     bufferModel()->setCurrentIndex(current.sibling(0,0));
 566   }
 567
 568   // and remove it from the model
 569   networkModel()->removeBuffer(bufferId);
 570
 571   if(buff)
 572     buff->deleteLater();
 573 }
 574
 575 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
 576   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
 577   if(bufferIndex.isValid()) {
 578     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
 579   }
 580 }