1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "coresession.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"
43 #include "messageevent.h"
44 #include "signalproxy.h"
48 class ProcessMessagesEvent : public QEvent {
50 ProcessMessagesEvent() : QEvent(QEvent::User) {}
53 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
56 _signalProxy(new SignalProxy(SignalProxy::Server, 0, 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)),
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)
72 SignalProxy *p = signalProxy();
73 p->setHeartBeatInterval(30);
74 p->setMaxHeartBeatCount(60); // 30 mins until we throw a dead socket out
76 connect(p, SIGNAL(peerRemoved(QIODevice *)), this, SLOT(removeClient(QIODevice *)));
78 connect(p, SIGNAL(connected()), this, SLOT(clientsConnected()));
79 connect(p, SIGNAL(disconnected()), this, SLOT(clientsDisconnected()));
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)));
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)));
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)));
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
104 // periodically save our session state
105 connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), this, SLOT(saveSessionState()));
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
116 restoreSessionState();
121 CoreSession::~CoreSession() {
123 foreach(CoreNetwork *net, _networks.values()) {
128 CoreNetwork *CoreSession::network(NetworkId id) const {
129 if(_networks.contains(id)) return _networks[id];
133 CoreIdentity *CoreSession::identity(IdentityId id) const {
134 if(_identities.contains(id)) return _identities[id];
138 void CoreSession::loadSettings() {
139 CoreUserSettings s(user());
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);
157 s.removeIdentity(id);
161 foreach(CoreIdentity identity, Core::identities(user())) {
162 createIdentity(identity);
165 foreach(NetworkInfo info, Core::networks(user())) {
170 void CoreSession::saveSessionState() const {
171 _bufferSyncer->storeDirtyIds();
172 _bufferViewManager->saveBufferViews();
173 _networkConfig->save();
176 void CoreSession::restoreSessionState() {
177 QList<NetworkId> nets = Core::connectedNetworks(user());
178 CoreNetwork *net = 0;
179 foreach(NetworkId id, nets) {
186 void CoreSession::addClient(QIODevice *device) {
188 qCritical() << "Invoking CoreSession::addClient with a QObject that is not a QIODevice!";
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);
195 reply["MsgType"] = "SessionInit";
196 reply["SessionState"] = sessionState();
197 SignalProxy::writeDataToDevice(device, reply);
201 void CoreSession::addClient(SignalProxy *proxy) {
202 signalProxy()->addPeer(proxy);
203 emit sessionState(sessionState());
206 void CoreSession::removeClient(QIODevice *iodev) {
207 QTcpSocket *socket = qobject_cast<QTcpSocket *>(iodev);
209 quInfo() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("disconnected (UserId: %1).").arg(user().toInt()));
212 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const {
213 return Core::persistentChannels(user(), id);
216 // FIXME switch to BufferId
217 void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg) {
218 CoreNetwork *net = network(bufinfo.networkId());
220 net->userInput(bufinfo, msg);
222 qWarning() << "Trying to send to unconnected network:" << msg;
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) {
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);
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)
244 _messageQueue << rawMsg;
245 if(!_processMessages) {
246 _processMessages = true;
247 QCoreApplication::postEvent(this, new ProcessMessagesEvent());
251 void CoreSession::recvStatusMsgFromServer(QString msg) {
252 CoreNetwork *net = qobject_cast<CoreNetwork*>(sender());
254 emit displayStatusMsg(net->networkName(), msg);
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(),
265 QList<BufferInfo> CoreSession::buffers() const {
266 return Core::requestBuffers(user());
269 void CoreSession::customEvent(QEvent *event) {
270 if(event->type() != QEvent::User)
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, "");
286 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
287 Core::storeMessage(msg);
288 emit displayMsg(msg);
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];
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;
306 bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
308 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
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];
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;
323 Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
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]);
333 _processMessages = false;
334 _messageQueue.clear();
337 QVariant CoreSession::sessionState() {
340 v["CoreFeatures"] = (int)Quassel::features();
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;
349 quint32 ircusercount = 0;
350 quint32 ircchannelcount = 0;
351 foreach(Network *net, _networks.values()) {
352 ircusercount += net->ircUserCount();
353 ircchannelcount += net->ircChannelCount();
355 v["IrcUserCount"] = ircusercount;
356 v["IrcChannelCount"] = ircchannelcount;
358 QList<QVariant> idlist;
359 foreach(Identity *i, _identities.values()) idlist << qVariantFromValue(*i);
360 v["Identities"] = idlist;
362 //v["Payload"] = QByteArray(100000000, 'a'); // for testing purposes
366 void CoreSession::initScriptEngine() {
367 signalProxy()->attachSlot(SIGNAL(scriptRequest(QString)), this, SLOT(scriptRequest(QString)));
368 signalProxy()->attachSignal(this, SIGNAL(scriptResult(QString)));
371 //QScriptValue storage_ = scriptEngine->newQObject(storage);
372 //scriptEngine->globalObject().setProperty("storage", storage_);
375 void CoreSession::scriptRequest(QString script) {
376 emit scriptResult(scriptEngine->evaluate(script).toString());
379 /*** Identity Handling ***/
380 void CoreSession::createIdentity(const Identity &identity, const QVariantMap &additional) {
385 CoreIdentity coreIdentity(identity);
387 if(additional.contains("KeyPem"))
388 coreIdentity.setSslKey(additional["KeyPem"].toByteArray());
389 if(additional.contains("CertPem"))
390 coreIdentity.setSslCert(additional["CertPem"].toByteArray());
392 qDebug() << Q_FUNC_INFO;
393 IdentityId id = Core::createIdentity(user(), coreIdentity);
397 createIdentity(coreIdentity);
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);
409 void CoreSession::updateIdentityBySender() {
410 CoreIdentity *identity = qobject_cast<CoreIdentity *>(sender());
413 Core::updateIdentity(user(), *identity);
416 void CoreSession::removeIdentity(IdentityId id) {
417 CoreIdentity *identity = _identities.take(id);
419 emit identityRemoved(id);
420 Core::removeIdentity(user(), id);
421 identity->deleteLater();
425 /*** Network Handling ***/
427 void CoreSession::createNetwork(const NetworkInfo &info_, const QStringList &persistentChans) {
428 NetworkInfo info = info_;
431 if(!info.networkId.isValid())
432 Core::createNetwork(user(), info);
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));
439 id = info.networkId.toInt();
440 if(!_networks.contains(id)) {
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);
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));
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)));
460 net->setNetworkInfo(info);
461 net->setProxy(signalProxy());
463 signalProxy()->synchronize(net);
464 emit networkCreated(id);
466 qWarning() << qPrintable(tr("CoreSession::createNetwork(): Trying to create a network that already exists, updating instead!"));
467 _networks[info.networkId]->requestSetNetworkInfo(info);
471 void CoreSession::removeNetwork(NetworkId id) {
472 // Make sure the network is disconnected!
473 CoreNetwork *net = network(id);
477 if(net->connectionState() != Network::Disconnected) {
478 connect(net, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
479 net->disconnectFromIrc();
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);
492 emit networkRemoved(id);
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);
504 void CoreSession::clientsConnected() {
505 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
506 Identity *identity = 0;
507 CoreNetwork *net = 0;
509 while(netIter != _networks.end()) {
513 if(!net->isConnected())
515 identity = net->identityPtr();
522 if(identity->detachAwayEnabled() && me->isAway()) {
523 net->userInputHandler()->handleAway(BufferInfo(), QString());
528 void CoreSession::clientsDisconnected() {
529 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
530 Identity *identity = 0;
531 CoreNetwork *net = 0;
534 while(netIter != _networks.end()) {
538 if(!net->isConnected())
541 identity = net->identityPtr();
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);
558 void CoreSession::globalAway(const QString &msg) {
559 QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
560 CoreNetwork *net = 0;
561 while(netIter != _networks.end()) {
565 if(!net->isConnected())
568 net->userInputHandler()->issueAway(msg, false /* no force away */);