src/client/client.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 "abstractmessageprocessor.h"
  24 #include "abstractui.h"
  25 #include "bufferinfo.h"
  26 #include "buffermodel.h"
  27 #include "buffersettings.h"
  28 #include "buffersyncer.h"
  29 #include "bufferviewconfig.h"
  30 #include "bufferviewoverlay.h"
  31 #include "clientaliasmanager.h"
  32 #include "clientbacklogmanager.h"
  33 #include "clientbufferviewmanager.h"
  34 #include "clientirclisthelper.h"
  35 #include "clientidentity.h"
  36 #include "clientignorelistmanager.h"
  37 #include "clientuserinputhandler.h"
  38 #include "ircchannel.h"
  39 #include "ircuser.h"
  40 #include "message.h"
  41 #include "messagemodel.h"
  42 #include "network.h"
  43 #include "networkconfig.h"
  44 #include "networkmodel.h"
  45 #include "quassel.h"
  46 #include "signalproxy.h"
  47 #include "util.h"
  48
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51
  52 QPointer<Client> Client::instanceptr = 0;
  53 AccountId Client::_currentCoreAccount = 0;
  54
  55 /*** Initialization/destruction ***/
  56
  57 bool Client::instanceExists()
  58 {
  59   return instanceptr;
  60 }
  61
  62 Client *Client::instance() {
  63   if(!instanceptr)
  64     instanceptr = new Client();
  65   return instanceptr;
  66 }
  67
  68 void Client::destroy() {
  69   if(instanceptr) {
  70     delete instanceptr->mainUi();
  71     instanceptr->deleteLater();
  72     instanceptr = 0;
  73   }
  74 }
  75
  76 void Client::init(AbstractUi *ui) {
  77   instance()->_mainUi = ui;
  78   instance()->init();
  79 }
  80
  81 Client::Client(QObject *parent)
  82   : QObject(parent),
  83     _signalProxy(new SignalProxy(SignalProxy::Client, this)),
  84     _mainUi(0),
  85     _networkModel(0),
  86     _bufferModel(0),
  87     _bufferSyncer(0),
  88     _aliasManager(0),
  89     _backlogManager(new ClientBacklogManager(this)),
  90     _bufferViewManager(0),
  91     _bufferViewOverlay(new BufferViewOverlay(this)),
  92     _ircListHelper(new ClientIrcListHelper(this)),
  93     _inputHandler(0),
  94     _networkConfig(0),
  95     _ignoreListManager(0),
  96     _messageModel(0),
  97     _messageProcessor(0),
  98     _connectedToCore(false),
  99     _syncedToCore(false),
 100     _internalCore(false),
 101     _debugLog(&_debugLogBuffer)
 102 {
 103   _signalProxy->synchronize(_ircListHelper);
 104 }
 105
 106 Client::~Client() {
 107   disconnectFromCore();
 108 }
 109
 110 void Client::init() {
 111   _currentCoreAccount = 0;
 112   _networkModel = new NetworkModel(this);
 113
 114   connect(this, SIGNAL(networkRemoved(NetworkId)),
 115           _networkModel, SLOT(networkRemoved(NetworkId)));
 116
 117   _bufferModel = new BufferModel(_networkModel);
 118   _messageModel = mainUi()->createMessageModel(this);
 119   _messageProcessor = mainUi()->createMessageProcessor(this);
 120   _inputHandler = new ClientUserInputHandler(this);
 121
 122   SignalProxy *p = signalProxy();
 123
 124   p->attachSlot(SIGNAL(displayMsg(const Message &)), this, SLOT(recvMessage(const Message &)));
 125   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)), this, SLOT(recvStatusMsg(QString, QString)));
 126
 127   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), _networkModel, SLOT(bufferUpdated(BufferInfo)));
 128   p->attachSignal(inputHandler(), SIGNAL(sendInput(BufferInfo, QString)));
 129   p->attachSignal(this, SIGNAL(requestNetworkStates()));
 130
 131   p->attachSignal(this, SIGNAL(requestCreateIdentity(const Identity &, const QVariantMap &)), SIGNAL(createIdentity(const Identity &, const QVariantMap &)));
 132   p->attachSignal(this, SIGNAL(requestRemoveIdentity(IdentityId)), SIGNAL(removeIdentity(IdentityId)));
 133   p->attachSlot(SIGNAL(identityCreated(const Identity &)), this, SLOT(coreIdentityCreated(const Identity &)));
 134   p->attachSlot(SIGNAL(identityRemoved(IdentityId)), this, SLOT(coreIdentityRemoved(IdentityId)));
 135
 136   p->attachSignal(this, SIGNAL(requestCreateNetwork(const NetworkInfo &, const QStringList &)), SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)));
 137   p->attachSignal(this, SIGNAL(requestRemoveNetwork(NetworkId)), SIGNAL(removeNetwork(NetworkId)));
 138   p->attachSlot(SIGNAL(networkCreated(NetworkId)), this, SLOT(coreNetworkCreated(NetworkId)));
 139   p->attachSlot(SIGNAL(networkRemoved(NetworkId)), this, SLOT(coreNetworkRemoved(NetworkId)));
 140
 141   connect(p, SIGNAL(disconnected()), this, SLOT(disconnectedFromCore()));
 142
 143   //connect(mainUi(), SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
 144   connect(mainUi(), SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
 145   connect(this, SIGNAL(connected()), mainUi(), SLOT(connectedToCore()));
 146   connect(this, SIGNAL(disconnected()), mainUi(), SLOT(disconnectedFromCore()));
 147
 148   // attach backlog manager
 149   p->synchronize(backlogManager());
 150   connect(backlogManager(), SIGNAL(messagesReceived(BufferId, int)), _messageModel, SLOT(messagesReceived(BufferId, int)));
 151 }
 152
 153 /*** public static methods ***/
 154
 155 AbstractUi *Client::mainUi() {
 156   return instance()->_mainUi;
 157 }
 158
 159 AccountId Client::currentCoreAccount() {
 160   return _currentCoreAccount;
 161 }
 162
 163 void Client::setCurrentCoreAccount(AccountId id) {
 164   _currentCoreAccount = id;
 165 }
 166
 167 bool Client::isConnected() {
 168   return instance()->_connectedToCore;
 169 }
 170
 171 bool Client::isSynced() {
 172   return instance()->_syncedToCore;
 173 }
 174
 175 /*** Network handling ***/
 176
 177 QList<NetworkId> Client::networkIds() {
 178   return instance()->_networks.keys();
 179 }
 180
 181 const Network * Client::network(NetworkId networkid) {
 182   if(instance()->_networks.contains(networkid)) return instance()->_networks[networkid];
 183   else return 0;
 184 }
 185
 186 void Client::createNetwork(const NetworkInfo &info, const QStringList &persistentChannels) {
 187   emit instance()->requestCreateNetwork(info, persistentChannels);
 188 }
 189
 190 void Client::removeNetwork(NetworkId id) {
 191   emit instance()->requestRemoveNetwork(id);
 192 }
 193
 194 void Client::updateNetwork(const NetworkInfo &info) {
 195   Network *netptr = instance()->_networks.value(info.networkId, 0);
 196   if(!netptr) {
 197     qWarning() << "Update for unknown network requested:" << info;
 198     return;
 199   }
 200   netptr->requestSetNetworkInfo(info);
 201 }
 202
 203 void Client::addNetwork(Network *net) {
 204   net->setProxy(signalProxy());
 205   signalProxy()->synchronize(net);
 206   networkModel()->attachNetwork(net);
 207   connect(net, SIGNAL(destroyed()), instance(), SLOT(networkDestroyed()));
 208   instance()->_networks[net->networkId()] = net;
 209   emit instance()->networkCreated(net->networkId());
 210 }
 211
 212 void Client::coreNetworkCreated(NetworkId id) {
 213   if(_networks.contains(id)) {
 214     qWarning() << "Creation of already existing network requested!";
 215     return;
 216   }
 217   Network *net = new Network(id, this);
 218   addNetwork(net);
 219 }
 220
 221 void Client::coreNetworkRemoved(NetworkId id) {
 222   if(!_networks.contains(id))
 223     return;
 224   Network *net = _networks.take(id);
 225   emit networkRemoved(net->networkId());
 226   net->deleteLater();
 227 }
 228
 229 /*** Identity handling ***/
 230
 231 QList<IdentityId> Client::identityIds() {
 232   return instance()->_identities.keys();
 233 }
 234
 235 const Identity *Client::identity(IdentityId id) {
 236   if(instance()->_identities.contains(id)) return instance()->_identities[id];
 237   else return 0;
 238 }
 239
 240 void Client::createIdentity(const CertIdentity &id) {
 241   QVariantMap additional;
 242 #ifdef HAVE_SSL
 243   additional["KeyPem"] = id.sslKey().toPem();
 244   additional["CertPem"] = id.sslCert().toPem();
 245 #endif
 246   emit instance()->requestCreateIdentity(id, additional);
 247 }
 248
 249 void Client::updateIdentity(IdentityId id, const QVariantMap &ser) {
 250   Identity *idptr = instance()->_identities.value(id, 0);
 251   if(!idptr) {
 252     qWarning() << "Update for unknown identity requested:" << id;
 253     return;
 254   }
 255   idptr->requestUpdate(ser);
 256 }
 257
 258 void Client::removeIdentity(IdentityId id) {
 259   emit instance()->requestRemoveIdentity(id);
 260 }
 261
 262 void Client::coreIdentityCreated(const Identity &other) {
 263   if(!_identities.contains(other.id())) {
 264     Identity *identity = new Identity(other, this);
 265     _identities[other.id()] = identity;
 266     identity->setInitialized();
 267     signalProxy()->synchronize(identity);
 268     emit identityCreated(other.id());
 269   } else {
 270     qWarning() << tr("Identity already exists in client!");
 271   }
 272 }
 273
 274 void Client::coreIdentityRemoved(IdentityId id) {
 275   if(_identities.contains(id)) {
 276     emit identityRemoved(id);
 277     Identity *i = _identities.take(id);
 278     i->deleteLater();
 279   }
 280 }
 281
 282 /*** User input handling ***/
 283
 284 void Client::userInput(const BufferInfo &bufferInfo, const QString &message) {
 285   // we need to make sure that AliasManager is ready before processing input
 286   if(aliasManager() && aliasManager()->isInitialized())
 287     inputHandler()->handleUserInput(bufferInfo, message);
 288   else
 289    instance()-> _userInputBuffer.append(qMakePair(bufferInfo, message));
 290 }
 291
 292 void Client::sendBufferedUserInput() {
 293   for(int i = 0; i < _userInputBuffer.count(); i++)
 294     userInput(_userInputBuffer.at(i).first, _userInputBuffer.at(i).second);
 295
 296   _userInputBuffer.clear();
 297 }
 298
 299 /*** core connection stuff ***/
 300
 301 void Client::setConnectedToCore(AccountId id, QIODevice *socket) {
 302   if(socket) { // external core
 303     // if the socket is an orphan, the signalProxy adopts it.
 304     // -> we don't need to care about it anymore
 305     socket->setParent(0);
 306     signalProxy()->addPeer(socket);
 307   }
 308   _internalCore = !socket;
 309   _connectedToCore = true;
 310   setCurrentCoreAccount(id);
 311 }
 312
 313 void Client::setSyncedToCore() {
 314   // create buffersyncer
 315   Q_ASSERT(!_bufferSyncer);
 316   _bufferSyncer = new BufferSyncer(this);
 317   connect(bufferSyncer(), SIGNAL(lastSeenMsgSet(BufferId, MsgId)), _networkModel, SLOT(setLastSeenMsgId(BufferId, MsgId)));
 318   connect(bufferSyncer(), SIGNAL(bufferRemoved(BufferId)), this, SLOT(bufferRemoved(BufferId)));
 319   connect(bufferSyncer(), SIGNAL(bufferRenamed(BufferId, QString)), this, SLOT(bufferRenamed(BufferId, QString)));
 320   connect(bufferSyncer(), SIGNAL(buffersPermanentlyMerged(BufferId, BufferId)), this, SLOT(buffersPermanentlyMerged(BufferId, BufferId)));
 321   connect(bufferSyncer(), SIGNAL(buffersPermanentlyMerged(BufferId, BufferId)), _messageModel, SLOT(buffersPermanentlyMerged(BufferId, BufferId)));
 322   connect(networkModel(), SIGNAL(setLastSeenMsg(BufferId, MsgId)), bufferSyncer(), SLOT(requestSetLastSeenMsg(BufferId, const MsgId &)));
 323   signalProxy()->synchronize(bufferSyncer());
 324
 325   // create a new BufferViewManager
 326   Q_ASSERT(!_bufferViewManager);
 327   _bufferViewManager = new ClientBufferViewManager(signalProxy(), this);
 328   connect(bufferViewManager(), SIGNAL(initDone()), this, SLOT(createDefaultBufferView()));
 329
 330   // create AliasManager
 331   Q_ASSERT(!_aliasManager);
 332   _aliasManager = new ClientAliasManager(this);
 333   connect(aliasManager(), SIGNAL(initDone()), SLOT(sendBufferedUserInput()));
 334   signalProxy()->synchronize(aliasManager());
 335
 336   // create NetworkConfig
 337   Q_ASSERT(!_networkConfig);
 338   _networkConfig = new NetworkConfig("GlobalNetworkConfig", this);
 339   signalProxy()->synchronize(networkConfig());
 340
 341   // create IgnoreListManager
 342   Q_ASSERT(!_ignoreListManager);
 343   _ignoreListManager = new ClientIgnoreListManager(this);
 344   signalProxy()->synchronize(ignoreListManager());
 345
 346   // trigger backlog request once all active bufferviews are initialized
 347   connect(bufferViewOverlay(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
 348
 349   _syncedToCore = true;
 350   emit connected();
 351   emit coreConnectionStateChanged(true);
 352 }
 353
 354 void Client::requestInitialBacklog() {
 355   // usually it _should_ take longer until the bufferViews are initialized, so that's what
 356   // triggers this slot. But we have to make sure that we know all buffers yet.
 357   // so we check the BufferSyncer and in case it wasn't initialized we wait for that instead
 358   if(!bufferSyncer()->isInitialized()) {
 359     connect(bufferViewOverlay(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
 360     connect(bufferSyncer(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
 361     return;
 362   }
 363   _backlogManager->requestInitialBacklog();
 364 }
 365
 366 void Client::createDefaultBufferView() {
 367   if(bufferViewManager()->bufferViewConfigs().isEmpty()) {
 368     BufferViewConfig config(-1);
 369     config.setBufferViewName(tr("All Chats"));
 370     config.initSetBufferList(networkModel()->allBufferIdsSorted());
 371     bufferViewManager()->requestCreateBufferView(config.toVariantMap());
 372   }
 373 }
 374
 375 void Client::disconnectFromCore() {
 376   if(!isConnected())
 377     return;
 378
 379   signalProxy()->removeAllPeers();
 380 }
 381
 382 void Client::disconnectedFromCore() {
 383   _connectedToCore = false;
 384   _syncedToCore = false;
 385   emit disconnected();
 386   emit coreConnectionStateChanged(false);
 387
 388   backlogManager()->reset();
 389   messageProcessor()->reset();
 390
 391   // Clear internal data. Hopefully nothing relies on it at this point.
 392   setCurrentCoreAccount(0);
 393
 394   if(_bufferSyncer) {
 395     _bufferSyncer->deleteLater();
 396     _bufferSyncer = 0;
 397   }
 398
 399   if(_bufferViewManager) {
 400     _bufferViewManager->deleteLater();
 401     _bufferViewManager = 0;
 402   }
 403
 404   if(_aliasManager) {
 405     _aliasManager->deleteLater();
 406     _aliasManager = 0;
 407   }
 408
 409   if(_ignoreListManager) {
 410     _ignoreListManager->deleteLater();
 411     _ignoreListManager = 0;
 412   }
 413   // we probably don't want to save pending input for reconnect
 414   _userInputBuffer.clear();
 415
 416   _messageModel->clear();
 417   _networkModel->clear();
 418
 419   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
 420   while(netIter != _networks.end()) {
 421     Network *net = netIter.value();
 422     emit networkRemoved(net->networkId());
 423     disconnect(net, SIGNAL(destroyed()), this, 0);
 424     netIter = _networks.erase(netIter);
 425     net->deleteLater();
 426   }
 427   Q_ASSERT(_networks.isEmpty());
 428
 429   QHash<IdentityId, Identity *>::iterator idIter = _identities.begin();
 430   while(idIter != _identities.end()) {
 431     emit identityRemoved(idIter.key());
 432     Identity *id = idIter.value();
 433     idIter = _identities.erase(idIter);
 434     id->deleteLater();
 435   }
 436   Q_ASSERT(_identities.isEmpty());
 437
 438   if(_networkConfig) {
 439     _networkConfig->deleteLater();
 440     _networkConfig = 0;
 441   }
 442 }
 443
 444 /*** ***/
 445
 446 void Client::networkDestroyed() {
 447   Network *net = static_cast<Network *>(sender());
 448   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
 449   while(netIter != _networks.end()) {
 450     if(*netIter == net) {
 451       netIter = _networks.erase(netIter);
 452       break;
 453     } else {
 454       netIter++;
 455     }
 456   }
 457 }
 458
 459 // Hmm... we never used this...
 460 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
 461   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
 462 }
 463
 464 void Client::recvMessage(const Message &msg) {
 465   Message msg_ = msg;
 466   messageProcessor()->process(msg_);
 467 }
 468
 469 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
 470   if(!bufferSyncer())
 471     return;
 472   bufferSyncer()->requestSetLastSeenMsg(id, msgId);
 473 }
 474
 475 void Client::removeBuffer(BufferId id) {
 476   if(!bufferSyncer()) return;
 477   bufferSyncer()->requestRemoveBuffer(id);
 478 }
 479
 480 void Client::renameBuffer(BufferId bufferId, const QString &newName) {
 481   if(!bufferSyncer())
 482     return;
 483   bufferSyncer()->requestRenameBuffer(bufferId, newName);
 484 }
 485
 486 void Client::mergeBuffersPermanently(BufferId bufferId1, BufferId bufferId2) {
 487   if(!bufferSyncer())
 488     return;
 489   bufferSyncer()->requestMergeBuffersPermanently(bufferId1, bufferId2);
 490 }
 491
 492 void Client::purgeKnownBufferIds() {
 493   if(!bufferSyncer())
 494     return;
 495   bufferSyncer()->requestPurgeBufferIds();
 496 }
 497
 498 void Client::bufferRemoved(BufferId bufferId) {
 499   // select a sane buffer (status buffer)
 500   /* we have to manually select a buffer because otherwise inconsitent changes
 501    * to the model might occur:
 502    * the result of a buffer removal triggers a change in the selection model.
 503    * the newly selected buffer might be a channel that hasn't been selected yet
 504    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
 505    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
 506    */
 507   QModelIndex current = bufferModel()->currentIndex();
 508   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
 509     bufferModel()->setCurrentIndex(current.sibling(0,0));
 510   }
 511
 512   // and remove it from the model
 513   networkModel()->removeBuffer(bufferId);
 514 }
 515
 516 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
 517   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
 518   if(bufferIndex.isValid()) {
 519     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
 520   }
 521 }
 522
 523 void Client::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2) {
 524   QModelIndex idx = networkModel()->bufferIndex(bufferId1);
 525   bufferModel()->setCurrentIndex(bufferModel()->mapFromSource(idx));
 526   networkModel()->removeBuffer(bufferId2);
 527 }
 528
 529 void Client::logMessage(QtMsgType type, const char *msg) {
 530   fprintf(stderr, "%s\n", msg);
 531   fflush(stderr);
 532   if(type == QtFatalMsg) {
 533     Quassel::logFatalMessage(msg);
 534   } else {
 535     QString msgString = QString("%1\n").arg(msg);
 536
 537     //Check to see if there is an instance around, else we risk recursions
 538     //when calling instance() and creating new ones.
 539     if (!instanceExists())
 540       return;
 541
 542     instance()->_debugLog << msgString;
 543     emit instance()->logUpdated(msgString);
 544   }
 545 }