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 }
 130
 131 /*** public static methods ***/
 132
 133 AccountId Client::currentCoreAccount() {
 134   return _currentCoreAccount;
 135 }
 136
 137 void Client::setCurrentCoreAccount(AccountId id) {
 138   _currentCoreAccount = id;
 139 }
 140
 141 QList<BufferInfo> Client::allBufferInfos() {
 142   QList<BufferInfo> bufferids;
 143   foreach(Buffer *buffer, buffers()) {
 144     bufferids << buffer->bufferInfo();
 145   }
 146   return bufferids;
 147 }
 148
 149 QList<Buffer *> Client::buffers() {
 150   return instance()->_buffers.values();
 151 }
 152
 153
 154 Buffer *Client::statusBuffer(const NetworkId &networkId) const {
 155   if(_statusBuffers.contains(networkId))
 156     return _statusBuffers[networkId];
 157   else
 158     return 0;
 159 }
 160
 161 Buffer *Client::buffer(BufferId bufferId) {
 162   if(instance()->_buffers.contains(bufferId))
 163     return instance()->_buffers[bufferId];
 164   else
 165     return 0;
 166 }
 167
 168 Buffer *Client::buffer(BufferInfo bufferInfo) {
 169   Buffer *buff = buffer(bufferInfo.bufferId());
 170
 171   if(!buff) {
 172     Client *client = Client::instance();
 173     buff = new Buffer(bufferInfo, client);
 174     connect(buff, SIGNAL(destroyed()), client, SLOT(bufferDestroyed()));
 175     client->_buffers[bufferInfo.bufferId()] = buff;
 176     if(bufferInfo.type() == BufferInfo::StatusBuffer)
 177       client->_statusBuffers[bufferInfo.networkId()] = buff;
 178
 179     emit client->bufferUpdated(bufferInfo);
 180
 181     // I don't like this: but currently there isn't really a prettier way:
 182     if(isSynced()) {  // this slows down syncing a lot, so disable it during sync
 183       QModelIndex bufferIdx = networkModel()->bufferIndex(bufferInfo.bufferId());
 184       bufferModel()->setCurrentIndex(bufferModel()->mapFromSource(bufferIdx));
 185     }
 186   }
 187   Q_ASSERT(buff);
 188   return buff;
 189 }
 190
 191 bool Client::isConnected() {
 192   return instance()->_connectedToCore;
 193 }
 194
 195 bool Client::isSynced() {
 196   return instance()->_syncedToCore;
 197 }
 198
 199 /*** Network handling ***/
 200
 201 QList<NetworkId> Client::networkIds() {
 202   return instance()->_networks.keys();
 203 }
 204
 205 const Network * Client::network(NetworkId networkid) {
 206   if(instance()->_networks.contains(networkid)) return instance()->_networks[networkid];
 207   else return 0;
 208 }
 209
 210 void Client::createNetwork(const NetworkInfo &info) {
 211   emit instance()->requestCreateNetwork(info);
 212 }
 213
 214 void Client::updateNetwork(const NetworkInfo &info) {
 215   emit instance()->requestUpdateNetwork(info);
 216 }
 217
 218 void Client::removeNetwork(NetworkId id) {
 219   emit instance()->requestRemoveNetwork(id);
 220 }
 221
 222 void Client::addNetwork(Network *net) {
 223   net->setProxy(signalProxy());
 224   signalProxy()->synchronize(net);
 225   networkModel()->attachNetwork(net);
 226   connect(net, SIGNAL(destroyed()), instance(), SLOT(networkDestroyed()));
 227   instance()->_networks[net->networkId()] = net;
 228   emit instance()->networkCreated(net->networkId());
 229 }
 230
 231 void Client::coreNetworkCreated(NetworkId id) {
 232   if(_networks.contains(id)) {
 233     qWarning() << "Creation of already existing network requested!";
 234     return;
 235   }
 236   Network *net = new Network(id, this);
 237   addNetwork(net);
 238 }
 239
 240 void Client::coreNetworkRemoved(NetworkId id) {
 241   if(!_networks.contains(id))
 242     return;
 243   Network *net = _networks.take(id);
 244   emit networkRemoved(net->networkId());
 245   net->deleteLater();
 246 }
 247
 248 /*** Identity handling ***/
 249
 250 QList<IdentityId> Client::identityIds() {
 251   return instance()->_identities.keys();
 252 }
 253
 254 const Identity * Client::identity(IdentityId id) {
 255   if(instance()->_identities.contains(id)) return instance()->_identities[id];
 256   else return 0;
 257 }
 258
 259 void Client::createIdentity(const Identity &id) {
 260   emit instance()->requestCreateIdentity(id);
 261 }
 262
 263 void Client::updateIdentity(const Identity &id) {
 264   emit instance()->requestUpdateIdentity(id);
 265 }
 266
 267 void Client::removeIdentity(IdentityId id) {
 268   emit instance()->requestRemoveIdentity(id);
 269 }
 270
 271 void Client::coreIdentityCreated(const Identity &other) {
 272   if(!_identities.contains(other.id())) {
 273     Identity *identity = new Identity(other, this);
 274     _identities[other.id()] = identity;
 275     identity->setInitialized();
 276     signalProxy()->synchronize(identity);
 277     emit identityCreated(other.id());
 278   } else {
 279     qWarning() << tr("Identity already exists in client!");
 280   }
 281 }
 282
 283 void Client::coreIdentityRemoved(IdentityId id) {
 284   if(_identities.contains(id)) {
 285     emit identityRemoved(id);
 286     Identity *i = _identities.take(id);
 287     i->deleteLater();
 288   }
 289 }
 290
 291 /***  ***/
 292 void Client::userInput(BufferInfo bufferInfo, QString message) {
 293   emit instance()->sendInput(bufferInfo, message);
 294 }
 295
 296 /*** core connection stuff ***/
 297
 298 void Client::setConnectedToCore(QIODevice *sock, AccountId id) {
 299   socket = sock;
 300   signalProxy()->addPeer(socket);
 301   _connectedToCore = true;
 302   setCurrentCoreAccount(id);
 303 }
 304
 305 void Client::setSyncedToCore() {
 306   // create buffersyncer
 307   Q_ASSERT(!_bufferSyncer);
 308   _bufferSyncer = new BufferSyncer(this);
 309   connect(bufferSyncer(), SIGNAL(lastSeenMsgSet(BufferId, MsgId)), this, SLOT(updateLastSeenMsg(BufferId, MsgId)));
 310   connect(bufferSyncer(), SIGNAL(bufferRemoved(BufferId)), this, SLOT(bufferRemoved(BufferId)));
 311   connect(bufferSyncer(), SIGNAL(bufferRenamed(BufferId, QString)), this, SLOT(bufferRenamed(BufferId, QString)));
 312   signalProxy()->synchronize(bufferSyncer());
 313
 314   // attach backlog manager
 315   signalProxy()->synchronize(backlogManager());
 316
 317   // create a new BufferViewManager
 318   _bufferViewManager = new BufferViewManager(signalProxy(), this);
 319
 320   _syncedToCore = true;
 321   emit connected();
 322   emit coreConnectionStateChanged(true);
 323 }
 324
 325 void Client::setSecuredConnection() {
 326   emit securedConnection();
 327 }
 328
 329 void Client::disconnectFromCore() {
 330   if(!isConnected())
 331     return;
 332   _connectedToCore = false;
 333
 334   if(socket) {
 335     socket->close();
 336     socket->deleteLater();
 337   }
 338   _syncedToCore = false;
 339   emit disconnected();
 340   emit coreConnectionStateChanged(false);
 341
 342   // Clear internal data. Hopefully nothing relies on it at this point.
 343   setCurrentCoreAccount(0);
 344
 345   if(_bufferSyncer) {
 346     _bufferSyncer->deleteLater();
 347     _bufferSyncer = 0;
 348   }
 349
 350   if(_bufferViewManager) {
 351     _bufferViewManager->deleteLater();
 352     _bufferViewManager = 0;
 353   }
 354
 355   _messageModel->clear();
 356   _networkModel->clear();
 357
 358   QHash<BufferId, Buffer *>::iterator bufferIter =  _buffers.begin();
 359   while(bufferIter != _buffers.end()) {
 360     Buffer *buffer = bufferIter.value();
 361     disconnect(buffer, SIGNAL(destroyed()), this, 0);
 362     bufferIter = _buffers.erase(bufferIter);
 363     buffer->deleteLater();
 364   }
 365   Q_ASSERT(_buffers.isEmpty());
 366
 367   _statusBuffers.clear();
 368
 369   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
 370   while(netIter != _networks.end()) {
 371     Network *net = netIter.value();
 372     emit networkRemoved(net->networkId());
 373     disconnect(net, SIGNAL(destroyed()), this, 0);
 374     netIter = _networks.erase(netIter);
 375     net->deleteLater();
 376   }
 377   Q_ASSERT(_networks.isEmpty());
 378
 379   QHash<IdentityId, Identity*>::iterator idIter = _identities.begin();
 380   while(idIter != _identities.end()) {
 381     Identity *id = idIter.value();
 382     emit identityRemoved(id->id());
 383     idIter = _identities.erase(idIter);
 384     id->deleteLater();
 385   }
 386   Q_ASSERT(_identities.isEmpty());
 387
 388 }
 389
 390 void Client::setCoreConfiguration(const QVariantMap &settings) {
 391   SignalProxy::writeDataToDevice(socket, settings);
 392 }
 393
 394 /*** ***/
 395
 396 void Client::updateBufferInfo(BufferInfo id) {
 397   emit bufferUpdated(id);
 398 }
 399
 400 void Client::bufferDestroyed() {
 401   Buffer *buffer = static_cast<Buffer *>(sender());
 402   QHash<BufferId, Buffer *>::iterator iter = _buffers.begin();
 403   while(iter != _buffers.end()) {
 404     if(iter.value() == buffer) {
 405       iter = _buffers.erase(iter);
 406       break;
 407     }
 408     iter++;
 409   }
 410
 411   QHash<NetworkId, Buffer *>::iterator statusIter = _statusBuffers.begin();
 412   while(statusIter != _statusBuffers.end()) {
 413     if(statusIter.value() == buffer) {
 414       statusIter = _statusBuffers.erase(statusIter);
 415       break;
 416     }
 417     statusIter++;
 418   }
 419 }
 420
 421 void Client::networkDestroyed() {
 422   Network *net = static_cast<Network *>(sender());
 423   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
 424   while(netIter != _networks.end()) {
 425     if(*netIter == net) {
 426       netIter = _networks.erase(netIter);
 427       break;
 428     } else {
 429       netIter++;
 430     }
 431   }
 432 }
 433
 434 void Client::recvMessage(const Message &msg_) {
 435   Message msg = msg_;
 436   checkForHighlight(msg);
 437   _messageModel->insertMessage(msg);
 438   buffer(msg.bufferInfo())->updateActivityLevel(msg);
 439 }
 440
 441 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
 442   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
 443 }
 444
 445 void Client::receiveBacklog(BufferId bufferId, const QVariantList &msgs) {
 446   //QTime start = QTime::currentTime();
 447   foreach(QVariant v, msgs) {
 448     Message msg = v.value<Message>();
 449     checkForHighlight(msg);
 450     _messageModel->insertMessage(msg);
 451     buffer(msg.bufferInfo())->updateActivityLevel(msg);
 452   }
 453   //qDebug() << "processed" << msgs.count() << "backlog lines in" << start.msecsTo(QTime::currentTime());
 454 }
 455
 456 // TODO optimize checkForHighlight
 457 void Client::checkForHighlight(Message &msg) {
 458   if(!((msg.type() & (Message::Plain | Message::Notice | Message::Action)) && !(msg.flags() & Message::Self)))
 459     return;
 460
 461   NotificationSettings notificationSettings;
 462   const Network *net = network(msg.bufferInfo().networkId());
 463   if(net && !net->myNick().isEmpty()) {
 464     QStringList nickList;
 465     if(notificationSettings.highlightNick() == NotificationSettings::CurrentNick) {
 466       nickList << net->myNick();
 467     } else if(notificationSettings.highlightNick() == NotificationSettings::AllNicks) {
 468       const Identity *myIdentity = identity(net->identity());
 469       if(myIdentity)
 470         nickList = myIdentity->nicks();
 471     }
 472     foreach(QString nickname, nickList) {
 473       QRegExp nickRegExp("^(.*\\W)?" + QRegExp::escape(nickname) + "(\\W.*)?$");
 474       if(nickRegExp.exactMatch(msg.contents())) {
 475         msg.setFlags(msg.flags() | Message::Highlight);
 476         return;
 477       }
 478     }
 479
 480     foreach(QVariant highlight, notificationSettings.highlightList()) {
 481       QVariantMap highlightRule = highlight.toMap();
 482       if(!highlightRule["enable"].toBool())
 483         continue;
 484       Qt::CaseSensitivity caseSensitivity = highlightRule["cs"].toBool() ? Qt::CaseSensitive : Qt::CaseInsensitive;
 485       QString name = highlightRule["name"].toString();
 486       QRegExp userRegExp;
 487       if(highlightRule["regex"].toBool()) {
 488         userRegExp = QRegExp(name, caseSensitivity);
 489       } else {
 490         userRegExp = QRegExp("^(.*\\W)?" + QRegExp::escape(name) + "(\\W.*)?$", caseSensitivity);
 491       }
 492       if(userRegExp.exactMatch(msg.contents())) {
 493         msg.setFlags(msg.flags() | Message::Highlight);
 494         return;
 495       }
 496     }
 497   }
 498 }
 499
 500 void Client::updateLastSeenMsg(BufferId id, const MsgId &msgId) {
 501   Buffer *b = buffer(id);
 502   if(!b) {
 503     qWarning() << "Client::updateLastSeen(): Unknown buffer" << id;
 504     return;
 505   }
 506   b->setLastSeenMsg(msgId);
 507 }
 508
 509 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
 510   if(!bufferSyncer())
 511     return;
 512   bufferSyncer()->requestSetLastSeenMsg(id, msgId);
 513 }
 514
 515 void Client::removeBuffer(BufferId id) {
 516   if(!bufferSyncer()) return;
 517   bufferSyncer()->requestRemoveBuffer(id);
 518 }
 519
 520 void Client::bufferRemoved(BufferId bufferId) {
 521   // first remove the buffer from hash. this prohibits further lastSeenUpdates
 522   Buffer *buff = 0;
 523   if(_buffers.contains(bufferId)) {
 524     buff = _buffers.take(bufferId);
 525     disconnect(buff, 0, this, 0);
 526   }
 527
 528   // then we select a sane buffer (status buffer)
 529   /* we have to manually select a buffer because otherwise inconsitent changes
 530    * to the model might occur:
 531    * the result of a buffer removal triggers a change in the selection model.
 532    * the newly selected buffer might be a channel that hasn't been selected yet
 533    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
 534    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
 535    */
 536   QModelIndex current = bufferModel()->currentIndex();
 537   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
 538     bufferModel()->setCurrentIndex(current.sibling(0,0));
 539   }
 540
 541   // and remove it from the model
 542   networkModel()->removeBuffer(bufferId);
 543
 544   if(buff)
 545     buff->deleteLater();
 546 }
 547
 548 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
 549   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
 550   if(bufferIndex.isValid()) {
 551     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
 552   }
 553 }