1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "coresession.h"
26 #include "coreuserinputhandler.h"
27 #include "corebuffersyncer.h"
28 #include "corebacklogmanager.h"
29 #include "corebufferviewmanager.h"
30 #include "coreeventmanager.h"
31 #include "coreidentity.h"
32 #include "coreignorelistmanager.h"
33 #include "coreirclisthelper.h"
34 #include "corenetwork.h"
35 #include "corenetworkconfig.h"
36 #include "coresessioneventprocessor.h"
37 #include "coreusersettings.h"
38 #include "ctcpparser.h"
39 #include "eventstringifier.h"
40 #include "ircchannel.h"
41 #include "ircparser.h"
44 #include "messageevent.h"
45 #include "signalproxy.h"
49 class ProcessMessagesEvent : public QEvent {
51 ProcessMessagesEvent() : QEvent(QEvent::User) {}
54 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
57 _signalProxy(new SignalProxy(SignalProxy::Server, 0, this)),
59 _bufferSyncer(new CoreBufferSyncer(this)),
60 _backlogManager(new CoreBacklogManager(this)),
61 _bufferViewManager(new CoreBufferViewManager(_signalProxy, this)),
62 _ircListHelper(new CoreIrcListHelper(this)),
63 _networkConfig(new CoreNetworkConfig("GlobalNetworkConfig", this)),
65 _eventManager(new CoreEventManager(this)),
66 _eventStringifier(new EventStringifier(this)),
67 _sessionEventProcessor(new CoreSessionEventProcessor(this)),
68 _ctcpParser(new CtcpParser(this)),
69 _ircParser(new IrcParser(this)),
70 scriptEngine(new QScriptEngine(this)),
71 _processMessages(false),
72 _ignoreListManager(this)
74 SignalProxy *p = signalProxy();
75 p->setHeartBeatInterval(30);
76 p->setMaxHeartBeatCount(60); // 30 mins until we throw a dead socket out
78 connect(p, SIGNAL(peerRemoved(QIODevice *)), this, SLOT(removeClient(QIODevice *)));
80 connect(p, SIGNAL(connected()), this, SLOT(clientsConnected()));
81 connect(p, SIGNAL(disconnected()), this, SLOT(clientsDisconnected()));
83 p->attachSlot(SIGNAL(sendInput(BufferInfo, QString)), this, SLOT(msgFromClient(BufferInfo, QString)));
84 p->attachSignal(this, SIGNAL(displayMsg(Message)));
85 p->attachSignal(this, SIGNAL(displayStatusMsg(QString, QString)));
87 p->attachSignal(this, SIGNAL(identityCreated(const Identity &)));
88 p->attachSignal(this, SIGNAL(identityRemoved(IdentityId)));
89 p->attachSlot(SIGNAL(createIdentity(const Identity &, const QVariantMap &)), this, SLOT(createIdentity(const Identity &, const QVariantMap &)));
90 p->attachSlot(SIGNAL(removeIdentity(IdentityId)), this, SLOT(removeIdentity(IdentityId)));
92 p->attachSignal(this, SIGNAL(networkCreated(NetworkId)));
93 p->attachSignal(this, SIGNAL(networkRemoved(NetworkId)));
94 p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)), this, SLOT(createNetwork(const NetworkInfo &, const QStringList &)));
95 p->attachSlot(SIGNAL(removeNetwork(NetworkId)), this, SLOT(removeNetwork(NetworkId)));
100 eventManager()->registerObject(ircParser(), EventManager::NormalPriority);
101 eventManager()->registerObject(sessionEventProcessor(), EventManager::HighPriority); // needs to process events *before* the stringifier!
102 eventManager()->registerObject(ctcpParser(), EventManager::NormalPriority);
103 eventManager()->registerObject(eventStringifier(), EventManager::NormalPriority);
104 eventManager()->registerObject(this, EventManager::LowPriority); // for sending MessageEvents to the client
105 // some events need to be handled after msg generation
106 eventManager()->registerObject(sessionEventProcessor(), EventManager::LowPriority, "lateProcess");
107 eventManager()->registerObject(ctcpParser(), EventManager::LowPriority, "send");
109 // periodically save our session state
110 connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), this, SLOT(saveSessionState()));
112 p->synchronize(_bufferSyncer);
113 p->synchronize(&aliasManager());
114 p->synchronize(_backlogManager);
115 p->synchronize(ircListHelper());
116 p->synchronize(networkConfig());
117 p->synchronize(&_coreInfo);
118 p->synchronize(&_ignoreListManager);
119 // Restore session state
121 restoreSessionState();
126 CoreSession::~CoreSession() {
128 foreach(CoreNetwork *net, _networks.values()) {
133 CoreNetwork *CoreSession::network(NetworkId id) const {
134 if(_networks.contains(id)) return _networks[id];
138 CoreIdentity *CoreSession::identity(IdentityId id) const {
139 if(_identities.contains(id)) return _identities[id];
143 void CoreSession::loadSettings() {
144 CoreUserSettings s(user());
147 QList<IdentityId> ids = s.identityIds();
148 QList<NetworkInfo> networkInfos = Core::networks(user());
149 foreach(IdentityId id, ids) {
150 CoreIdentity identity(s.identity(id));
151 IdentityId newId = Core::createIdentity(user(), identity);
152 QList<NetworkInfo>::iterator networkIter = networkInfos.begin();
153 while(networkIter != networkInfos.end()) {
154 if(networkIter->identity == id) {
155 networkIter->identity = newId;
156 Core::updateNetwork(user(), *networkIter);
157 networkIter = networkInfos.erase(networkIter);
162 s.removeIdentity(id);
166 foreach(CoreIdentity identity, Core::identities(user())) {
167 createIdentity(identity);
170 foreach(NetworkInfo info, Core::networks(user())) {
175 void CoreSession::saveSessionState() const {
176 _bufferSyncer->storeDirtyIds();
177 _bufferViewManager->saveBufferViews();
178 _networkConfig->save();
181 void CoreSession::restoreSessionState() {
182 QList<NetworkId> nets = Core::connectedNetworks(user());
183 CoreNetwork *net = 0;
184 foreach(NetworkId id, nets) {
191 void CoreSession::addClient(QIODevice *device) {
193 qCritical() << "Invoking CoreSession::addClient with a QObject that is not a QIODevice!";
195 // if the socket is an orphan, the signalProxy adopts it.
196 // -> we don't need to care about it anymore
197 device->setParent(0);
198 signalProxy()->addPeer(device);
200 reply["MsgType"] = "SessionInit";
201 reply["SessionState"] = sessionState();
202 SignalProxy::writeDataToDevice(device, reply);
206 void CoreSession::addClient(SignalProxy *proxy) {
207 signalProxy()->addPeer(proxy);
208 emit sessionState(sessionState());
211 void CoreSession::removeClient(QIODevice *iodev) {
212 QTcpSocket *socket = qobject_cast<QTcpSocket *>(iodev);
214 quInfo() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("disconnected (UserId: %1).").arg(user().toInt()));
217 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const {
218 return Core::persistentChannels(user(), id);
221 // FIXME switch to BufferId
222 void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg) {
223 CoreNetwork *net = network(bufinfo.networkId());
225 net->userInput(bufinfo, msg);
227 qWarning() << "Trying to send to unconnected network:" << msg;
231 // ALL messages coming pass through these functions before going to the GUI.
232 // So this is the perfect place for storing the backlog and log stuff.
233 void CoreSession::recvMessageFromServer(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType,
234 const QString &target, const QString &text_, const QString &sender, Message::Flags flags) {
236 // U+FDD0 and U+FDD1 are special characters for Qt's text engine, specifically they mark the boundaries of
237 // text frames in a QTextDocument. This might lead to problems in widgets displaying QTextDocuments (such as
238 // KDE's notifications), hence we remove those just to be safe.
239 QString text = text_;
240 text.remove(QChar(0xfdd0)).remove(QChar(0xfdd1));
241 RawMessage rawMsg(networkId, type, bufferType, target, text, sender, flags);
243 // check for HardStrictness ignore
244 CoreNetwork *currentNetwork = network(networkId);
245 QString networkName = currentNetwork ? currentNetwork->networkName() : QString("");
246 if(_ignoreListManager.match(rawMsg, networkName) == IgnoreListManager::HardStrictness)
249 _messageQueue << rawMsg;
250 if(!_processMessages) {
251 _processMessages = true;
252 QCoreApplication::postEvent(this, new ProcessMessagesEvent());
256 void CoreSession::recvStatusMsgFromServer(QString msg) {
257 CoreNetwork *net = qobject_cast<CoreNetwork*>(sender());
259 emit displayStatusMsg(net->networkName(), msg);
262 void CoreSession::processMessageEvent(MessageEvent *event) {
263 recvMessageFromServer(event->networkId(), event->msgType(), event->bufferType(),
264 event->target().isNull()? "" : event->target(),
265 event->text().isNull()? "" : event->text(),
266 event->sender().isNull()? "" : event->sender(),
270 QList<BufferInfo> CoreSession::buffers() const {
271 return Core::requestBuffers(user());
274 void CoreSession::customEvent(QEvent *event) {
275 if(event->type() != QEvent::User)
282 void CoreSession::processMessages() {
283 if(_messageQueue.count() == 1) {
284 const RawMessage &rawMsg = _messageQueue.first();
285 bool createBuffer = !(rawMsg.flags & Message::Redirected);
286 BufferInfo bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
287 if(!bufferInfo.isValid()) {
288 Q_ASSERT(!createBuffer);
289 bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
291 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
292 Core::storeMessage(msg);
293 emit displayMsg(msg);
295 QHash<NetworkId, QHash<QString, BufferInfo> > bufferInfoCache;
296 MessageList messages;
297 QList<RawMessage> redirectedMessages; // list of Messages which don't enforce a buffer creation
298 BufferInfo bufferInfo;
299 for(int i = 0; i < _messageQueue.count(); i++) {
300 const RawMessage &rawMsg = _messageQueue.at(i);
301 if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
302 bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
304 bool createBuffer = !(rawMsg.flags & Message::Redirected);
305 bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
306 if(!bufferInfo.isValid()) {
307 Q_ASSERT(!createBuffer);
308 redirectedMessages << rawMsg;
311 bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
313 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
317 // recheck if there exists a buffer to store a redirected message in
318 for(int i = 0; i < redirectedMessages.count(); i++) {
319 const RawMessage &rawMsg = _messageQueue.at(i);
320 if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
321 bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
323 // no luck -> we store them in the StatusBuffer
324 bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
325 // add the StatusBuffer to the Cache in case there are more Messages for the original target
326 bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
328 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
332 Core::storeMessages(messages);
333 // FIXME: extend protocol to a displayMessages(MessageList)
334 for(int i = 0; i < messages.count(); i++) {
335 emit displayMsg(messages[i]);
338 _processMessages = false;
339 _messageQueue.clear();
342 QVariant CoreSession::sessionState() {
345 v["CoreFeatures"] = (int)Quassel::features();
348 foreach(BufferInfo id, buffers()) bufs << qVariantFromValue(id);
349 v["BufferInfos"] = bufs;
350 QVariantList networkids;
351 foreach(NetworkId id, _networks.keys()) networkids << qVariantFromValue(id);
352 v["NetworkIds"] = networkids;
354 quint32 ircusercount = 0;
355 quint32 ircchannelcount = 0;
356 foreach(Network *net, _networks.values()) {
357 ircusercount += net->ircUserCount();
358 ircchannelcount += net->ircChannelCount();
360 v["IrcUserCount"] = ircusercount;
361 v["IrcChannelCount"] = ircchannelcount;
363 QList<QVariant> idlist;
364 foreach(Identity *i, _identities.values()) idlist << qVariantFromValue(*i);
365 v["Identities"] = idlist;
367 //v["Payload"] = QByteArray(100000000, 'a'); // for testing purposes
371 void CoreSession::initScriptEngine() {
372 signalProxy()->attachSlot(SIGNAL(scriptRequest(QString)), this, SLOT(scriptRequest(QString)));
373 signalProxy()->attachSignal(this, SIGNAL(scriptResult(QString)));
376 //QScriptValue storage_ = scriptEngine->newQObject(storage);
377 //scriptEngine->globalObject().setProperty("storage", storage_);
380 void CoreSession::scriptRequest(QString script) {
381 emit scriptResult(scriptEngine->evaluate(script).toString());
384 /*** Identity Handling ***/
385 void CoreSession::createIdentity(const Identity &identity, const QVariantMap &additional) {
390 CoreIdentity coreIdentity(identity);
392 if(additional.contains("KeyPem"))
393 coreIdentity.setSslKey(additional["KeyPem"].toByteArray());
394 if(additional.contains("CertPem"))
395 coreIdentity.setSslCert(additional["CertPem"].toByteArray());
397 qDebug() << Q_FUNC_INFO;
398 IdentityId id = Core::createIdentity(user(), coreIdentity);
402 createIdentity(coreIdentity);
405 void CoreSession::createIdentity(const CoreIdentity &identity) {
406 CoreIdentity *coreIdentity = new CoreIdentity(identity, this);
407 _identities[identity.id()] = coreIdentity;
408 // CoreIdentity has its own synchronize method since its "private" sslManager needs to be synced as well
409 coreIdentity->synchronize(signalProxy());
410 connect(coreIdentity, SIGNAL(updated()), this, SLOT(updateIdentityBySender()));
411 emit identityCreated(*coreIdentity);
414 void CoreSession::updateIdentityBySender() {
415 CoreIdentity *identity = qobject_cast<CoreIdentity *>(sender());
418 Core::updateIdentity(user(), *identity);
421 void CoreSession::removeIdentity(IdentityId id) {
422 CoreIdentity *identity = _identities.take(id);
424 emit identityRemoved(id);
425 Core::removeIdentity(user(), id);
426 identity->deleteLater();
430 /*** Network Handling ***/
432 void CoreSession::createNetwork(const NetworkInfo &info_, const QStringList &persistentChans) {
433 NetworkInfo info = info_;
436 if(!info.networkId.isValid())
437 Core::createNetwork(user(), info);
439 if(!info.networkId.isValid()) {
440 qWarning() << qPrintable(tr("CoreSession::createNetwork(): Got invalid networkId from Core when trying to create network %1!").arg(info.networkName));
444 id = info.networkId.toInt();
445 if(!_networks.contains(id)) {
447 // create persistent chans
448 QRegExp rx("\\s*(\\S+)(?:\\s*(\\S+))?\\s*");
449 foreach(QString channel, persistentChans) {
450 if(!rx.exactMatch(channel)) {
451 qWarning() << QString("Invalid persistent channel declaration: %1").arg(channel);
454 Core::bufferInfo(user(), info.networkId, BufferInfo::ChannelBuffer, rx.cap(1), true);
455 Core::setChannelPersistent(user(), info.networkId, rx.cap(1), true);
456 if(!rx.cap(2).isEmpty())
457 Core::setPersistentChannelKey(user(), info.networkId, rx.cap(1), rx.cap(2));
460 CoreNetwork *net = new CoreNetwork(id, this);
461 connect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)),
462 SLOT(recvMessageFromServer(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)));
463 connect(net, SIGNAL(displayStatusMsg(QString)), SLOT(recvStatusMsgFromServer(QString)));
464 connect(net, SIGNAL(disconnected(NetworkId)), SIGNAL(networkDisconnected(NetworkId)));
466 net->setNetworkInfo(info);
467 net->setProxy(signalProxy());
469 signalProxy()->synchronize(net);
470 emit networkCreated(id);
472 qWarning() << qPrintable(tr("CoreSession::createNetwork(): Trying to create a network that already exists, updating instead!"));
473 _networks[info.networkId]->requestSetNetworkInfo(info);
477 void CoreSession::removeNetwork(NetworkId id) {
478 // Make sure the network is disconnected!
479 CoreNetwork *net = network(id);
483 if(net->connectionState() != Network::Disconnected) {
484 // make sure we no longer receive data from the tcp buffer
485 disconnect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)), this, 0);
486 disconnect(net, SIGNAL(displayStatusMsg(QString)), this, 0);
487 connect(net, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
488 net->disconnectFromIrc();
494 void CoreSession::destroyNetwork(NetworkId id) {
495 QList<BufferId> removedBuffers = Core::requestBufferIdsForNetwork(user(), id);
496 Network *net = _networks.take(id);
497 if(net && Core::removeNetwork(user(), id)) {
498 // make sure that all unprocessed RawMessages from this network are removed
499 QList<RawMessage>::iterator messageIter = _messageQueue.begin();
500 while(messageIter != _messageQueue.end()) {
501 if(messageIter->networkId == id) {
502 messageIter = _messageQueue.erase(messageIter);
507 // remove buffers from syncer
508 foreach(BufferId bufferId, removedBuffers) {
509 _bufferSyncer->removeBuffer(bufferId);
511 emit networkRemoved(id);
516 void CoreSession::renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName) {
517 BufferInfo bufferInfo = Core::bufferInfo(user(), networkId, BufferInfo::QueryBuffer, oldName, false);
518 if(bufferInfo.isValid()) {
519 _bufferSyncer->renameBuffer(bufferInfo.bufferId(), newName);
523 void CoreSession::clientsConnected() {
524 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
525 Identity *identity = 0;
526 CoreNetwork *net = 0;
528 while(netIter != _networks.end()) {
532 if(!net->isConnected())
534 identity = net->identityPtr();
541 if(identity->detachAwayEnabled() && me->isAway()) {
542 net->userInputHandler()->handleAway(BufferInfo(), QString());
547 void CoreSession::clientsDisconnected() {
548 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
549 Identity *identity = 0;
550 CoreNetwork *net = 0;
553 while(netIter != _networks.end()) {
557 if(!net->isConnected())
560 identity = net->identityPtr();
567 if(identity->detachAwayEnabled() && !me->isAway()) {
568 if(!identity->detachAwayReason().isEmpty())
569 awayReason = identity->detachAwayReason();
570 net->setAutoAwayActive(true);
571 net->userInputHandler()->handleAway(BufferInfo(), awayReason);
577 void CoreSession::globalAway(const QString &msg) {
578 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
579 CoreNetwork *net = 0;
580 while(netIter != _networks.end()) {
584 if(!net->isConnected())
587 net->userInputHandler()->issueAway(msg, false /* no force away */);