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