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