Do not emit messages if storing them in the DB failed
[quassel.git] / src / core / coresession.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-2014 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 "coresession.h"
22
23 #include <QtScript>
24
25 #include "core.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 "internalpeer.h"
41 #include "ircchannel.h"
42 #include "ircparser.h"
43 #include "ircuser.h"
44 #include "logger.h"
45 #include "messageevent.h"
46 #include "remotepeer.h"
47 #include "storage.h"
48 #include "util.h"
49
50
51 class ProcessMessagesEvent : public QEvent
52 {
53 public:
54     ProcessMessagesEvent() : QEvent(QEvent::User) {}
55 };
56
57
58 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
59     : QObject(parent),
60     _user(uid),
61     _signalProxy(new SignalProxy(SignalProxy::Server, this)),
62     _aliasManager(this),
63     _bufferSyncer(new CoreBufferSyncer(this)),
64     _backlogManager(new CoreBacklogManager(this)),
65     _bufferViewManager(new CoreBufferViewManager(_signalProxy, this)),
66     _ircListHelper(new CoreIrcListHelper(this)),
67     _networkConfig(new CoreNetworkConfig("GlobalNetworkConfig", this)),
68     _coreInfo(this),
69     _eventManager(new CoreEventManager(this)),
70     _eventStringifier(new EventStringifier(this)),
71     _sessionEventProcessor(new CoreSessionEventProcessor(this)),
72     _ctcpParser(new CtcpParser(this)),
73     _ircParser(new IrcParser(this)),
74     scriptEngine(new QScriptEngine(this)),
75     _processMessages(false),
76     _ignoreListManager(this)
77 {
78     SignalProxy *p = signalProxy();
79     p->setHeartBeatInterval(30);
80     p->setMaxHeartBeatCount(60); // 30 mins until we throw a dead socket out
81
82     connect(p, SIGNAL(peerRemoved(Peer*)), SLOT(removeClient(Peer*)));
83
84     connect(p, SIGNAL(connected()), SLOT(clientsConnected()));
85     connect(p, SIGNAL(disconnected()), SLOT(clientsDisconnected()));
86
87     p->attachSlot(SIGNAL(sendInput(BufferInfo, QString)), this, SLOT(msgFromClient(BufferInfo, QString)));
88     p->attachSignal(this, SIGNAL(displayMsg(Message)));
89     p->attachSignal(this, SIGNAL(displayStatusMsg(QString, QString)));
90
91     p->attachSignal(this, SIGNAL(identityCreated(const Identity &)));
92     p->attachSignal(this, SIGNAL(identityRemoved(IdentityId)));
93     p->attachSlot(SIGNAL(createIdentity(const Identity &, const QVariantMap &)), this, SLOT(createIdentity(const Identity &, const QVariantMap &)));
94     p->attachSlot(SIGNAL(removeIdentity(IdentityId)), this, SLOT(removeIdentity(IdentityId)));
95
96     p->attachSignal(this, SIGNAL(networkCreated(NetworkId)));
97     p->attachSignal(this, SIGNAL(networkRemoved(NetworkId)));
98     p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)), this, SLOT(createNetwork(const NetworkInfo &, const QStringList &)));
99     p->attachSlot(SIGNAL(removeNetwork(NetworkId)), this, SLOT(removeNetwork(NetworkId)));
100
101     loadSettings();
102     initScriptEngine();
103
104     eventManager()->registerObject(ircParser(), EventManager::NormalPriority);
105     eventManager()->registerObject(sessionEventProcessor(), EventManager::HighPriority); // needs to process events *before* the stringifier!
106     eventManager()->registerObject(ctcpParser(), EventManager::NormalPriority);
107     eventManager()->registerObject(eventStringifier(), EventManager::NormalPriority);
108     eventManager()->registerObject(this, EventManager::LowPriority); // for sending MessageEvents to the client
109     // some events need to be handled after msg generation
110     eventManager()->registerObject(sessionEventProcessor(), EventManager::LowPriority, "lateProcess");
111     eventManager()->registerObject(ctcpParser(), EventManager::LowPriority, "send");
112
113     // periodically save our session state
114     connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), this, SLOT(saveSessionState()));
115
116     p->synchronize(_bufferSyncer);
117     p->synchronize(&aliasManager());
118     p->synchronize(_backlogManager);
119     p->synchronize(ircListHelper());
120     p->synchronize(networkConfig());
121     p->synchronize(&_coreInfo);
122     p->synchronize(&_ignoreListManager);
123     // Restore session state
124     if (restoreState)
125         restoreSessionState();
126
127     emit initialized();
128 }
129
130
131 CoreSession::~CoreSession()
132 {
133     saveSessionState();
134     foreach(CoreNetwork *net, _networks.values()) {
135         delete net;
136     }
137 }
138
139
140 CoreNetwork *CoreSession::network(NetworkId id) const
141 {
142     if (_networks.contains(id)) return _networks[id];
143     return 0;
144 }
145
146
147 CoreIdentity *CoreSession::identity(IdentityId id) const
148 {
149     if (_identities.contains(id)) return _identities[id];
150     return 0;
151 }
152
153
154 void CoreSession::loadSettings()
155 {
156     CoreUserSettings s(user());
157
158     // migrate to db
159     QList<IdentityId> ids = s.identityIds();
160     QList<NetworkInfo> networkInfos = Core::networks(user());
161     foreach(IdentityId id, ids) {
162         CoreIdentity identity(s.identity(id));
163         IdentityId newId = Core::createIdentity(user(), identity);
164         QList<NetworkInfo>::iterator networkIter = networkInfos.begin();
165         while (networkIter != networkInfos.end()) {
166             if (networkIter->identity == id) {
167                 networkIter->identity = newId;
168                 Core::updateNetwork(user(), *networkIter);
169                 networkIter = networkInfos.erase(networkIter);
170             }
171             else {
172                 networkIter++;
173             }
174         }
175         s.removeIdentity(id);
176     }
177     // end of migration
178
179     foreach(CoreIdentity identity, Core::identities(user())) {
180         createIdentity(identity);
181     }
182
183     foreach(NetworkInfo info, Core::networks(user())) {
184         createNetwork(info);
185     }
186 }
187
188
189 void CoreSession::saveSessionState() const
190 {
191     _bufferSyncer->storeDirtyIds();
192     _bufferViewManager->saveBufferViews();
193     _networkConfig->save();
194 }
195
196
197 void CoreSession::restoreSessionState()
198 {
199     QList<NetworkId> nets = Core::connectedNetworks(user());
200     CoreNetwork *net = 0;
201     foreach(NetworkId id, nets) {
202         net = network(id);
203         Q_ASSERT(net);
204         net->connectToIrc();
205     }
206 }
207
208
209 void CoreSession::addClient(RemotePeer *peer)
210 {
211     peer->dispatch(sessionState());
212     signalProxy()->addPeer(peer);
213 }
214
215
216 void CoreSession::addClient(InternalPeer *peer)
217 {
218     signalProxy()->addPeer(peer);
219     emit sessionState(sessionState());
220 }
221
222
223 void CoreSession::removeClient(Peer *peer)
224 {
225     RemotePeer *p = qobject_cast<RemotePeer *>(peer);
226     if (p)
227         quInfo() << qPrintable(tr("Client")) << p->description() << qPrintable(tr("disconnected (UserId: %1).").arg(user().toInt()));
228 }
229
230
231 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const
232 {
233     return Core::persistentChannels(user(), id);
234 }
235
236
237 // FIXME switch to BufferId
238 void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg)
239 {
240     CoreNetwork *net = network(bufinfo.networkId());
241     if (net) {
242         net->userInput(bufinfo, msg);
243     }
244     else {
245         qWarning() << "Trying to send to unconnected network:" << msg;
246     }
247 }
248
249
250 // ALL messages coming pass through these functions before going to the GUI.
251 // So this is the perfect place for storing the backlog and log stuff.
252 void CoreSession::recvMessageFromServer(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType,
253     const QString &target, const QString &text_, const QString &sender, Message::Flags flags)
254 {
255     // U+FDD0 and U+FDD1 are special characters for Qt's text engine, specifically they mark the boundaries of
256     // text frames in a QTextDocument. This might lead to problems in widgets displaying QTextDocuments (such as
257     // KDE's notifications), hence we remove those just to be safe.
258     QString text = text_;
259     text.remove(QChar(0xfdd0)).remove(QChar(0xfdd1));
260     RawMessage rawMsg(networkId, type, bufferType, target, text, sender, flags);
261
262     // check for HardStrictness ignore
263     CoreNetwork *currentNetwork = network(networkId);
264     QString networkName = currentNetwork ? currentNetwork->networkName() : QString("");
265     if (_ignoreListManager.match(rawMsg, networkName) == IgnoreListManager::HardStrictness)
266         return;
267
268     _messageQueue << rawMsg;
269     if (!_processMessages) {
270         _processMessages = true;
271         QCoreApplication::postEvent(this, new ProcessMessagesEvent());
272     }
273 }
274
275
276 void CoreSession::recvStatusMsgFromServer(QString msg)
277 {
278     CoreNetwork *net = qobject_cast<CoreNetwork *>(sender());
279     Q_ASSERT(net);
280     emit displayStatusMsg(net->networkName(), msg);
281 }
282
283
284 void CoreSession::processMessageEvent(MessageEvent *event)
285 {
286     recvMessageFromServer(event->networkId(), event->msgType(), event->bufferType(),
287         event->target().isNull() ? "" : event->target(),
288         event->text().isNull() ? "" : event->text(),
289         event->sender().isNull() ? "" : event->sender(),
290         event->msgFlags());
291 }
292
293
294 QList<BufferInfo> CoreSession::buffers() const
295 {
296     return Core::requestBuffers(user());
297 }
298
299
300 void CoreSession::customEvent(QEvent *event)
301 {
302     if (event->type() != QEvent::User)
303         return;
304
305     processMessages();
306     event->accept();
307 }
308
309
310 void CoreSession::processMessages()
311 {
312     if (_messageQueue.count() == 1) {
313         const RawMessage &rawMsg = _messageQueue.first();
314         bool createBuffer = !(rawMsg.flags & Message::Redirected);
315         BufferInfo bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
316         if (!bufferInfo.isValid()) {
317             Q_ASSERT(!createBuffer);
318             bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
319         }
320         Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
321         if(Core::storeMessage(msg))
322             emit displayMsg(msg);
323     }
324     else {
325         QHash<NetworkId, QHash<QString, BufferInfo> > bufferInfoCache;
326         MessageList messages;
327         QList<RawMessage> redirectedMessages; // list of Messages which don't enforce a buffer creation
328         BufferInfo bufferInfo;
329         for (int i = 0; i < _messageQueue.count(); i++) {
330             const RawMessage &rawMsg = _messageQueue.at(i);
331             if (bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
332                 bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
333             }
334             else {
335                 bool createBuffer = !(rawMsg.flags & Message::Redirected);
336                 bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
337                 if (!bufferInfo.isValid()) {
338                     Q_ASSERT(!createBuffer);
339                     redirectedMessages << rawMsg;
340                     continue;
341                 }
342                 bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
343             }
344             Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
345             messages << msg;
346         }
347
348         // recheck if there exists a buffer to store a redirected message in
349         for (int i = 0; i < redirectedMessages.count(); i++) {
350             const RawMessage &rawMsg = redirectedMessages.at(i);
351             if (bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
352                 bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
353             }
354             else {
355                 // no luck -> we store them in the StatusBuffer
356                 bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
357                 // add the StatusBuffer to the Cache in case there are more Messages for the original target
358                 bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
359             }
360             Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
361             messages << msg;
362         }
363
364         if(Core::storeMessages(messages)) {
365             // FIXME: extend protocol to a displayMessages(MessageList)
366             for (int i = 0; i < messages.count(); i++) {
367                 emit displayMsg(messages[i]);
368             }
369         }
370     }
371     _processMessages = false;
372     _messageQueue.clear();
373 }
374
375
376 Protocol::SessionState CoreSession::sessionState() const
377 {
378     QVariantList bufferInfos;
379     QVariantList networkIds;
380     QVariantList identities;
381
382     foreach(const BufferInfo &id, buffers())
383         bufferInfos << QVariant::fromValue(id);
384     foreach(const NetworkId &id, _networks.keys())
385         networkIds << QVariant::fromValue(id);
386     foreach(const Identity *i, _identities.values())
387         identities << QVariant::fromValue(*i);
388
389     return Protocol::SessionState(identities, bufferInfos, networkIds);
390 }
391
392
393 void CoreSession::initScriptEngine()
394 {
395     signalProxy()->attachSlot(SIGNAL(scriptRequest(QString)), this, SLOT(scriptRequest(QString)));
396     signalProxy()->attachSignal(this, SIGNAL(scriptResult(QString)));
397
398     // FIXME
399     //QScriptValue storage_ = scriptEngine->newQObject(storage);
400     //scriptEngine->globalObject().setProperty("storage", storage_);
401 }
402
403
404 void CoreSession::scriptRequest(QString script)
405 {
406     emit scriptResult(scriptEngine->evaluate(script).toString());
407 }
408
409
410 /*** Identity Handling ***/
411 void CoreSession::createIdentity(const Identity &identity, const QVariantMap &additional)
412 {
413 #ifndef HAVE_SSL
414     Q_UNUSED(additional)
415 #endif
416
417     CoreIdentity coreIdentity(identity);
418 #ifdef HAVE_SSL
419     if (additional.contains("KeyPem"))
420         coreIdentity.setSslKey(additional["KeyPem"].toByteArray());
421     if (additional.contains("CertPem"))
422         coreIdentity.setSslCert(additional["CertPem"].toByteArray());
423 #endif
424     qDebug() << Q_FUNC_INFO;
425     IdentityId id = Core::createIdentity(user(), coreIdentity);
426     if (!id.isValid())
427         return;
428     else
429         createIdentity(coreIdentity);
430 }
431
432
433 void CoreSession::createIdentity(const CoreIdentity &identity)
434 {
435     CoreIdentity *coreIdentity = new CoreIdentity(identity, this);
436     _identities[identity.id()] = coreIdentity;
437     // CoreIdentity has its own synchronize method since its "private" sslManager needs to be synced as well
438     coreIdentity->synchronize(signalProxy());
439     connect(coreIdentity, SIGNAL(updated()), this, SLOT(updateIdentityBySender()));
440     emit identityCreated(*coreIdentity);
441 }
442
443
444 void CoreSession::updateIdentityBySender()
445 {
446     CoreIdentity *identity = qobject_cast<CoreIdentity *>(sender());
447     if (!identity)
448         return;
449     Core::updateIdentity(user(), *identity);
450 }
451
452
453 void CoreSession::removeIdentity(IdentityId id)
454 {
455     CoreIdentity *identity = _identities.take(id);
456     if (identity) {
457         emit identityRemoved(id);
458         Core::removeIdentity(user(), id);
459         identity->deleteLater();
460     }
461 }
462
463
464 /*** Network Handling ***/
465
466 void CoreSession::createNetwork(const NetworkInfo &info_, const QStringList &persistentChans)
467 {
468     NetworkInfo info = info_;
469     int id;
470
471     if (!info.networkId.isValid())
472         Core::createNetwork(user(), info);
473
474     if (!info.networkId.isValid()) {
475         qWarning() << qPrintable(tr("CoreSession::createNetwork(): Got invalid networkId from Core when trying to create network %1!").arg(info.networkName));
476         return;
477     }
478
479     id = info.networkId.toInt();
480     if (!_networks.contains(id)) {
481         // create persistent chans
482         QRegExp rx("\\s*(\\S+)(?:\\s*(\\S+))?\\s*");
483         foreach(QString channel, persistentChans) {
484             if (!rx.exactMatch(channel)) {
485                 qWarning() << QString("Invalid persistent channel declaration: %1").arg(channel);
486                 continue;
487             }
488             Core::bufferInfo(user(), info.networkId, BufferInfo::ChannelBuffer, rx.cap(1), true);
489             Core::setChannelPersistent(user(), info.networkId, rx.cap(1), true);
490             if (!rx.cap(2).isEmpty())
491                 Core::setPersistentChannelKey(user(), info.networkId, rx.cap(1), rx.cap(2));
492         }
493
494         CoreNetwork *net = new CoreNetwork(id, this);
495         connect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)),
496             SLOT(recvMessageFromServer(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)));
497         connect(net, SIGNAL(displayStatusMsg(QString)), SLOT(recvStatusMsgFromServer(QString)));
498         connect(net, SIGNAL(disconnected(NetworkId)), SIGNAL(networkDisconnected(NetworkId)));
499
500         net->setNetworkInfo(info);
501         net->setProxy(signalProxy());
502         _networks[id] = net;
503         signalProxy()->synchronize(net);
504         emit networkCreated(id);
505     }
506     else {
507         qWarning() << qPrintable(tr("CoreSession::createNetwork(): Trying to create a network that already exists, updating instead!"));
508         _networks[info.networkId]->requestSetNetworkInfo(info);
509     }
510 }
511
512
513 void CoreSession::removeNetwork(NetworkId id)
514 {
515     // Make sure the network is disconnected!
516     CoreNetwork *net = network(id);
517     if (!net)
518         return;
519
520     if (net->connectionState() != Network::Disconnected) {
521         // make sure we no longer receive data from the tcp buffer
522         disconnect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)), this, 0);
523         disconnect(net, SIGNAL(displayStatusMsg(QString)), this, 0);
524         connect(net, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
525         net->disconnectFromIrc();
526     }
527     else {
528         destroyNetwork(id);
529     }
530 }
531
532
533 void CoreSession::destroyNetwork(NetworkId id)
534 {
535     QList<BufferId> removedBuffers = Core::requestBufferIdsForNetwork(user(), id);
536     Network *net = _networks.take(id);
537     if (net && Core::removeNetwork(user(), id)) {
538         // make sure that all unprocessed RawMessages from this network are removed
539         QList<RawMessage>::iterator messageIter = _messageQueue.begin();
540         while (messageIter != _messageQueue.end()) {
541             if (messageIter->networkId == id) {
542                 messageIter = _messageQueue.erase(messageIter);
543             }
544             else {
545                 messageIter++;
546             }
547         }
548         // remove buffers from syncer
549         foreach(BufferId bufferId, removedBuffers) {
550             _bufferSyncer->removeBuffer(bufferId);
551         }
552         emit networkRemoved(id);
553         net->deleteLater();
554     }
555 }
556
557
558 void CoreSession::renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName)
559 {
560     BufferInfo bufferInfo = Core::bufferInfo(user(), networkId, BufferInfo::QueryBuffer, oldName, false);
561     if (bufferInfo.isValid()) {
562         _bufferSyncer->renameBuffer(bufferInfo.bufferId(), newName);
563     }
564 }
565
566
567 void CoreSession::clientsConnected()
568 {
569     QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
570     Identity *identity = 0;
571     CoreNetwork *net = 0;
572     IrcUser *me = 0;
573     while (netIter != _networks.end()) {
574         net = *netIter;
575         netIter++;
576
577         if (!net->isConnected())
578             continue;
579         identity = net->identityPtr();
580         if (!identity)
581             continue;
582         me = net->me();
583         if (!me)
584             continue;
585
586         if (identity->detachAwayEnabled() && me->isAway()) {
587             net->userInputHandler()->handleAway(BufferInfo(), QString());
588         }
589     }
590 }
591
592
593 void CoreSession::clientsDisconnected()
594 {
595     QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
596     Identity *identity = 0;
597     CoreNetwork *net = 0;
598     IrcUser *me = 0;
599     QString awayReason;
600     while (netIter != _networks.end()) {
601         net = *netIter;
602         netIter++;
603
604         if (!net->isConnected())
605             continue;
606
607         identity = net->identityPtr();
608         if (!identity)
609             continue;
610         me = net->me();
611         if (!me)
612             continue;
613
614         if (identity->detachAwayEnabled() && !me->isAway()) {
615             if (!identity->detachAwayReason().isEmpty())
616                 awayReason = identity->detachAwayReason();
617             net->setAutoAwayActive(true);
618             net->userInputHandler()->handleAway(BufferInfo(), awayReason);
619         }
620     }
621 }
622
623
624 void CoreSession::globalAway(const QString &msg)
625 {
626     QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
627     CoreNetwork *net = 0;
628     while (netIter != _networks.end()) {
629         net = *netIter;
630         netIter++;
631
632         if (!net->isConnected())
633             continue;
634
635         net->userInputHandler()->issueAway(msg, false /* no force away */);
636     }
637 }