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