src/client/client.cpp

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