1 /***************************************************************************
2 * Copyright (C) 2005-2019 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #ifndef COREBASICHANDLER_H
22 #define COREBASICHANDLER_H
25 #include <QStringList>
27 #include "basichandler.h"
28 #include "corenetwork.h"
33 class CoreBasicHandler : public BasicHandler
38 CoreBasicHandler(CoreNetwork* parent = nullptr);
40 QString serverDecode(const QByteArray& string);
41 QStringList serverDecode(const QList<QByteArray>& stringlist);
42 QString channelDecode(const QString& bufferName, const QByteArray& string);
43 QStringList channelDecode(const QString& bufferName, const QList<QByteArray>& stringlist);
44 QString userDecode(const QString& userNick, const QByteArray& string);
45 QStringList userDecode(const QString& userNick, const QList<QByteArray>& stringlist);
47 QByteArray serverEncode(const QString& string);
48 QList<QByteArray> serverEncode(const QStringList& stringlist);
49 QByteArray channelEncode(const QString& bufferName, const QString& string);
50 QList<QByteArray> channelEncode(const QString& bufferName, const QStringList& stringlist);
51 QByteArray userEncode(const QString& userNick, const QString& string);
52 QList<QByteArray> userEncode(const QString& userNick, const QStringList& stringlist);
55 void displayMsg(const NetworkInternalMessage& msg);
58 * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
60 * @see CoreNetwork::putRawLine()
62 void putRawLine(const QByteArray& msg, bool prepend = false);
65 * Sends the command with encoded parameters, with optional prefix or high priority.
67 * @see CoreNetwork::putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray(), const
68 * QHash<IrcTagKey, QString>& tags = {}, bool prepend = false)
70 void putCmd(const QString& cmd, const QList<QByteArray>& params, const QByteArray& prefix = {}, const QHash<IrcTagKey, QString>& tags = {}, bool prepend = false);
73 * Sends the command for each set of encoded parameters, with optional prefix or high priority.
75 * @see CoreNetwork::putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray(), const
76 * QHash<IrcTagKey, QString>& tags = {}, bool prepend = false)
78 void putCmd(const QString& cmd, const QList<QList<QByteArray>>& params, const QByteArray& prefix = {}, const QHash<IrcTagKey, QString>& tags = {}, bool prepend = false);
82 * Sends the command with one parameter, with optional prefix or high priority.
84 * @param[in] cmd Command to send, ignoring capitalization
85 * @param[in] param Parameter for the command, encoded within a QByteArray
86 * @param[in] prefix Optional command prefix
87 * @param[in] tags Optional command tags
90 * If true, the command is prepended into the start of the queue, otherwise, it's appended to
91 * the end. This should be used sparingly, for if either the core or the IRC server cannot
92 * maintain PING/PONG replies, the other side will close the connection.
95 void putCmd(const QString& cmd, const QByteArray& param, const QByteArray& prefix = QByteArray(), const QHash<IrcTagKey, QString>& tags = {}, bool prepend = false);
97 inline CoreNetwork* network() const { return _network; }
98 inline CoreSession* coreSession() const { return _network->coreSession(); }
100 BufferInfo::Type typeByTarget(const QString& target) const;
103 CoreNetwork* _network;