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