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 "ctcpparser.h"
23 #include "coresession.h"
24 #include "ctcpevent.h"
25 #include "messageevent.h"
27 const QByteArray XDELIM = "\001";
29 CtcpParser::CtcpParser(CoreSession *coreSession, QObject *parent)
31 _coreSession(coreSession)
33 QByteArray MQUOTE = QByteArray("\020");
34 _ctcpMDequoteHash[MQUOTE + '0'] = QByteArray(1, '\000');
35 _ctcpMDequoteHash[MQUOTE + 'n'] = QByteArray(1, '\n');
36 _ctcpMDequoteHash[MQUOTE + 'r'] = QByteArray(1, '\r');
37 _ctcpMDequoteHash[MQUOTE + MQUOTE] = MQUOTE;
39 QByteArray XQUOTE = QByteArray("\134");
40 _ctcpXDelimDequoteHash[XQUOTE + XQUOTE] = XQUOTE;
41 _ctcpXDelimDequoteHash[XQUOTE + QByteArray("a")] = XDELIM;
44 void CtcpParser::displayMsg(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
45 const QString &target, Message::Flags msgFlags) {
46 if(event->testFlag(EventManager::Silent))
49 MessageEvent *msgEvent = new MessageEvent(msgType, event->network(), msg, sender, target, msgFlags);
50 msgEvent->setTimestamp(event->timestamp());
52 coreSession()->eventManager()->sendEvent(msgEvent);
55 QByteArray CtcpParser::lowLevelQuote(const QByteArray &message) {
56 QByteArray quotedMessage = message;
58 QHash<QByteArray, QByteArray> quoteHash = _ctcpMDequoteHash;
59 QByteArray MQUOTE = QByteArray("\020");
60 quoteHash.remove(MQUOTE + MQUOTE);
61 quotedMessage.replace(MQUOTE, MQUOTE + MQUOTE);
63 QHash<QByteArray, QByteArray>::const_iterator quoteIter = quoteHash.constBegin();
64 while(quoteIter != quoteHash.constEnd()) {
65 quotedMessage.replace(quoteIter.value(), quoteIter.key());
71 QByteArray CtcpParser::lowLevelDequote(const QByteArray &message) {
72 QByteArray dequotedMessage;
73 QByteArray messagepart;
74 QHash<QByteArray, QByteArray>::iterator ctcpquote;
76 // copy dequote Message
77 for(int i = 0; i < message.size(); i++) {
78 messagepart = message.mid(i,1);
79 if(i+1 < message.size()) {
80 for(ctcpquote = _ctcpMDequoteHash.begin(); ctcpquote != _ctcpMDequoteHash.end(); ++ctcpquote) {
81 if(message.mid(i,2) == ctcpquote.key()) {
82 messagepart = ctcpquote.value();
88 dequotedMessage += messagepart;
90 return dequotedMessage;
93 QByteArray CtcpParser::xdelimQuote(const QByteArray &message) {
94 QByteArray quotedMessage = message;
95 QHash<QByteArray, QByteArray>::const_iterator quoteIter = _ctcpXDelimDequoteHash.constBegin();
96 while(quoteIter != _ctcpXDelimDequoteHash.constEnd()) {
97 quotedMessage.replace(quoteIter.value(), quoteIter.key());
100 return quotedMessage;
103 QByteArray CtcpParser::xdelimDequote(const QByteArray &message) {
104 QByteArray dequotedMessage;
105 QByteArray messagepart;
106 QHash<QByteArray, QByteArray>::iterator xdelimquote;
108 for(int i = 0; i < message.size(); i++) {
109 messagepart = message.mid(i,1);
110 if(i+1 < message.size()) {
111 for(xdelimquote = _ctcpXDelimDequoteHash.begin(); xdelimquote != _ctcpXDelimDequoteHash.end(); ++xdelimquote) {
112 if(message.mid(i,2) == xdelimquote.key()) {
113 messagepart = xdelimquote.value();
119 dequotedMessage += messagepart;
121 return dequotedMessage;
124 void CtcpParser::processIrcEventRawNotice(IrcEventRawMessage *event) {
125 parse(event, Message::Notice);
128 void CtcpParser::processIrcEventRawPrivmsg(IrcEventRawMessage *event) {
129 parse(event, Message::Plain);
132 void CtcpParser::parse(IrcEventRawMessage *e, Message::Type messagetype) {
135 //lowlevel message dequote
136 QByteArray dequotedMessage = lowLevelDequote(e->rawMessage());
138 CtcpEvent::CtcpType ctcptype = e->type() == EventManager::IrcEventRawNotice
142 Message::Flags flags = (ctcptype == CtcpEvent::Reply && !e->network()->isChannelName(e->target()))
143 ? Message::Redirected
146 QList<CtcpEvent *> ctcpEvents;
147 QUuid uuid; // needed to group all replies together
149 // extract tagged / extended data
151 int xdelimEndPos = -1;
153 while((xdelimPos = dequotedMessage.indexOf(XDELIM)) != -1) {
155 displayMsg(e, messagetype, targetDecode(e, dequotedMessage.left(xdelimPos)), e->prefix(), e->target(), flags);
157 xdelimEndPos = dequotedMessage.indexOf(XDELIM, xdelimPos + 1);
158 if(xdelimEndPos == -1) {
159 // no matching end delimiter found... treat rest of the message as ctcp
160 xdelimEndPos = dequotedMessage.count();
162 ctcp = xdelimDequote(dequotedMessage.mid(xdelimPos + 1, xdelimEndPos - xdelimPos - 1));
163 dequotedMessage = dequotedMessage.mid(xdelimEndPos + 1);
165 //dispatch the ctcp command
166 QString ctcpcmd = targetDecode(e, ctcp.left(spacePos));
167 QString ctcpparam = targetDecode(e, ctcp.mid(spacePos + 1));
169 spacePos = ctcp.indexOf(' ');
171 ctcpcmd = targetDecode(e, ctcp.left(spacePos));
172 ctcpparam = targetDecode(e, ctcp.mid(spacePos + 1));
174 ctcpcmd = targetDecode(e, ctcp);
175 ctcpparam = QString();
178 ctcpcmd = ctcpcmd.toUpper();
180 // we don't want to block /me messages by the CTCP ignore list
181 if(ctcpcmd == QLatin1String("ACTION") || !coreSession()->ignoreListManager()->ctcpMatch(e->prefix(), e->network()->networkName(), ctcpcmd)) {
183 uuid = QUuid::createUuid();
185 CtcpEvent *event = new CtcpEvent(EventManager::CtcpEvent, e->network(), e->prefix(), e->target(),
186 ctcptype, ctcpcmd, ctcpparam, e->timestamp(), uuid);
190 if(!ctcpEvents.isEmpty()) {
191 _replies.insert(uuid, CtcpReply(coreNetwork(e), nickFromMask(e->prefix())));
192 CtcpEvent *flushEvent = new CtcpEvent(EventManager::CtcpEventFlush, e->network(), e->prefix(), e->target(),
193 ctcptype, "INVALID", QString(), e->timestamp(), uuid);
194 ctcpEvents << flushEvent;
195 foreach(CtcpEvent *event, ctcpEvents) {
196 coreSession()->eventManager()->sendEvent(event);
200 if(!dequotedMessage.isEmpty())
201 displayMsg(e, messagetype, targetDecode(e, dequotedMessage), e->prefix(), e->target(), flags);
204 void CtcpParser::sendCtcpEvent(CtcpEvent *e) {
205 CoreNetwork *net = coreNetwork(e);
206 if(e->type() == EventManager::CtcpEvent) {
207 QByteArray quotedReply;
208 QString bufname = nickFromMask(e->prefix());
209 if(e->ctcpType() == CtcpEvent::Query && !e->reply().isNull()) {
210 if(_replies.contains(e->uuid()))
211 _replies[e->uuid()].replies << lowLevelQuote(pack(net->serverEncode(e->ctcpCmd()),
212 net->userEncode(bufname, e->reply())));
214 // reply not caused by a request processed in here, so send it off immediately
215 reply(net, bufname, e->ctcpCmd(), e->reply());
217 } else if(e->type() == EventManager::CtcpEventFlush && _replies.contains(e->uuid())) {
218 CtcpReply reply = _replies.take(e->uuid());
219 if(reply.replies.count())
220 packedReply(net, reply.bufferName, reply.replies);
224 QByteArray CtcpParser::pack(const QByteArray &ctcpTag, const QByteArray &message) {
225 if(message.isEmpty())
226 return XDELIM + ctcpTag + XDELIM;
228 return XDELIM + ctcpTag + ' ' + xdelimQuote(message) + XDELIM;
231 void CtcpParser::query(CoreNetwork *net, const QString &bufname, const QString &ctcpTag, const QString &message) {
232 QList<QByteArray> params;
233 params << net->serverEncode(bufname) << lowLevelQuote(pack(net->serverEncode(ctcpTag), net->userEncode(bufname, message)));
234 net->putCmd("PRIVMSG", params);
237 void CtcpParser::reply(CoreNetwork *net, const QString &bufname, const QString &ctcpTag, const QString &message) {
238 QList<QByteArray> params;
239 params << net->serverEncode(bufname) << lowLevelQuote(pack(net->serverEncode(ctcpTag), net->userEncode(bufname, message)));
240 net->putCmd("NOTICE", params);
243 void CtcpParser::packedReply(CoreNetwork *net, const QString &bufname, const QList<QByteArray> &replies) {
244 QList<QByteArray> params;
247 for(int i = 0; i < replies.count(); i++) {
248 answerSize += replies.at(i).size();
251 QByteArray quotedReply(answerSize, 0);
253 QByteArray &reply = quotedReply;
254 for(int i = 0; i < replies.count(); i++) {
255 reply = replies.at(i);
256 quotedReply.replace(nextPos, reply.size(), reply);
257 nextPos += reply.size();
260 params << net->serverEncode(bufname) << quotedReply;
261 // FIXME user proper event
262 net->putCmd("NOTICE", params);