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