1 /***************************************************************************
2 * Copyright (C) 2005-2010 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 "ircparser.h"
23 #include "corenetwork.h"
24 #include "eventmanager.h"
26 #include "messageevent.h"
27 #include "networkevent.h"
33 IrcParser::IrcParser(CoreSession *session) :
40 bool IrcParser::checkParamCount(const QString &cmd, const QList<QByteArray> ¶ms, int minParams) {
41 if(params.count() < minParams) {
42 qWarning() << "Expected" << minParams << "params for IRC command" << cmd << ", got:" << params;
48 QByteArray IrcParser::decrypt(Network *network, const QString &bufferName, const QByteArray &message, bool isTopic) {
53 Cipher *cipher = qobject_cast<CoreNetwork *>(network)->cipher(bufferName);
57 return isTopic? cipher->decryptTopic(message) : cipher->decrypt(message);
63 /* parse the raw server string and generate an appropriate event */
64 /* used to be handleServerMsg() */
65 void IrcParser::processNetworkIncoming(NetworkDataEvent *e) {
66 CoreNetwork *net = qobject_cast<CoreNetwork *>(e->network());
68 qWarning() << "Received network event without valid network pointer!";
72 // note that the IRC server is still alive
73 net->resetPingTimeout();
75 QByteArray msg = e->data();
77 qWarning() << "Received empty string from server!";
81 // Now we split the raw message into its various parts...
86 // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
87 // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
88 int idx = msg.indexOf(" :");
90 if(msg.length() > idx + 2)
91 trailing = msg.mid(idx + 2);
94 // OK, now it is safe to split...
95 QList<QByteArray> params = msg.split(' ');
97 // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row
98 // Also, QByteArray is not nearly as convenient to work with as QString for such things :)
99 QList<QByteArray>::iterator iter = params.begin();
100 while(iter != params.end()) {
102 iter = params.erase(iter);
107 if(!trailing.isEmpty())
109 if(params.count() < 1) {
110 qWarning() << "Received invalid string from server!";
114 QString foo = net->serverDecode(params.takeFirst());
116 // a colon as the first chars indicates the existence of a prefix
120 if(params.count() < 1) {
121 qWarning() << "Received invalid string from server!";
124 foo = net->serverDecode(params.takeFirst());
127 // next string without a whitespace is the command
130 QList<Event *> events;
131 EventManager::EventType type = EventManager::Invalid;
133 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
134 uint num = cmd.toUInt();
136 if(params.count() == 0) {
137 qWarning() << "Message received from server violates RFC and is ignored!" << msg;
140 target = net->serverDecode(params.takeFirst());
141 type = EventManager::IrcEventNumeric;
143 QString typeName = QLatin1String("IrcEvent") + cmd.at(0).toUpper() + cmd.mid(1).toLower();
144 type = eventManager()->eventTypeByName(typeName);
145 if(type == EventManager::Invalid) {
146 type = eventManager()->eventTypeByName("IrcEventUnknown");
147 Q_ASSERT(type != EventManager::Invalid);
152 // Almost always, all params are server-encoded. There's a few exceptions, let's catch them here!
153 // Possibly not the best option, we might want something more generic? Maybe yet another layer of
154 // unencoded events with event handlers for the exceptions...
155 // Also, PRIVMSG and NOTICE need some special handling, we put this in here as well, so we get out
156 // nice pre-parsed events that the CTCP handler can consume.
158 QStringList decParams;
159 bool defaultHandling = true; // whether to automatically copy the remaining params and send the event
163 case EventManager::IrcEventPrivmsg:
164 defaultHandling = false; // this might create a list of events
166 if(checkParamCount(cmd, params, 1)) {
167 QString senderNick = nickFromMask(prefix);
168 QByteArray msg = params.count() < 2 ? QByteArray() : params.at(1);
170 QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts);
171 QStringList::const_iterator targetIter;
172 for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) {
173 QString target = net->isChannelName(*targetIter) ? *targetIter : senderNick;
175 msg = decrypt(net, target, msg);
177 events << new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg, net, msg, prefix, target, e->timestamp());
182 case EventManager::IrcEventNotice:
183 defaultHandling = false;
185 if(checkParamCount(cmd, params, 2)) {
186 QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts);
187 QStringList::const_iterator targetIter;
188 for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) {
189 QString target = *targetIter;
191 // special treatment for welcome messages like:
192 // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message. This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68
193 if(!net->isChannelName(target)) {
194 QString decMsg = net->serverDecode(params.at(1));
195 QRegExp welcomeRegExp("^\\[([^\\]]+)\\] ");
196 if(welcomeRegExp.indexIn(decMsg) != -1) {
197 QString channelname = welcomeRegExp.cap(1);
198 decMsg = decMsg.mid(welcomeRegExp.matchedLength());
199 CoreIrcChannel *chan = static_cast<CoreIrcChannel *>(net->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe
200 if(chan && !chan->receivedWelcomeMsg()) {
201 chan->setReceivedWelcomeMsg();
202 events << new MessageEvent(Message::Notice, net, decMsg, prefix, channelname, Message::None, e->timestamp());
208 if(prefix.isEmpty() || target == "AUTH") {
211 if(!target.isEmpty() && net->prefixes().contains(target.at(0)))
212 target = target.mid(1);
213 if(!net->isChannelName(target))
214 target = nickFromMask(prefix);
216 events << new IrcEventRawMessage(EventManager::IrcEventRawNotice, net, params[1], prefix, target, e->timestamp());
221 // the following events need only special casing for param decoding
222 case EventManager::IrcEventKick:
223 if(params.count() >= 3) { // we have a reason
224 decParams << net->serverDecode(params.at(0)) << net->serverDecode(params.at(1));
225 decParams << net->channelDecode(decParams.first(), params.at(2)); // kick reason
229 case EventManager::IrcEventPart:
230 if(params.count() >= 2) {
231 QString channel = net->serverDecode(params.at(0));
232 decParams << channel;
233 decParams << net->userDecode(nickFromMask(prefix), params.at(1));
237 case EventManager::IrcEventQuit:
238 if(params.count() >= 1) {
239 decParams << net->userDecode(nickFromMask(prefix), params.at(0));
243 case EventManager::IrcEventTopic:
244 if(params.count() >= 1) {
245 QString channel = net->serverDecode(params.at(0));
246 decParams << channel;
247 decParams << (params.count() >= 2? net->channelDecode(channel, decrypt(net, channel, params.at(1), true)) : QString());
251 case EventManager::IrcEventNumeric:
253 case 301: /* RPL_AWAY */
254 if(params.count() >= 2) {
255 QString nick = net->serverDecode(params.at(0));
257 decParams << net->userDecode(nick, params.at(1));
261 case 332: /* RPL_TOPIC */
262 if(params.count() >= 2) {
263 QString channel = net->serverDecode(params.at(0));
264 decParams << channel;
265 decParams << net->channelDecode(channel, decrypt(net, channel, params.at(1), true));
269 case 333: /* Topic set by... */
270 if(params.count() >= 2) {
271 QString channel = net->serverDecode(params.at(0));
272 decParams << channel << net->serverDecode(params.at(1));
273 decParams << net->channelDecode(channel, params.at(2));
282 if(defaultHandling && type != EventManager::Invalid) {
283 for(int i = decParams.count(); i < params.count(); i++)
284 decParams << net->serverDecode(params.at(i));
287 if(type == EventManager::IrcEventNumeric)
288 event = new IrcEventNumeric(num, net, prefix, target);
290 event = new IrcEvent(type, net, prefix);
291 event->setParams(decParams);
292 event->setTimestamp(e->timestamp());
296 foreach(Event *event, events) {
297 coreSession()->eventManager()->sendEvent(event);