diff options
Diffstat (limited to 'kopete/protocols/irc/libkirc/kircmessage.h')
| -rw-r--r-- | kopete/protocols/irc/libkirc/kircmessage.h | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/kopete/protocols/irc/libkirc/kircmessage.h b/kopete/protocols/irc/libkirc/kircmessage.h new file mode 100644 index 00000000..e37f3fb2 --- /dev/null +++ b/kopete/protocols/irc/libkirc/kircmessage.h @@ -0,0 +1,198 @@ +/* + kircmessage.h - IRC Client + + Copyright (c) 2003 by Michel Hermier <michel.hermier@wanadoo.fr> + + Kopete (c) 2003 by the Kopete developers <kopete-devel@kde.org> + + ************************************************************************* + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + ************************************************************************* +*/ + +#ifndef KIRCMESSAGE_H +#define KIRCMESSAGE_H + +#include "kircentity.h" + +#include <kbufferedio.h> + +#include <qdict.h> +#include <qstring.h> +#include <qstringlist.h> +#include <qtextcodec.h> +#include <qregexp.h> + +#include <kopetemessage.h> + +// Uncoment this if you want a really rfc compliant message handling. +// This is due to some changes of the message encoding with 14 arguments.(not very frequent :) +// #define _IRC_STRICTNESS_ + +namespace KIRC +{ + +class Engine; + +class Message +{ +public: + /** \brief Sends the message as-is to the server. + */ + static void writeRawMessage(KIRC::Engine *engine, const QTextCodec *codec, const QString &str); + + static void writeMessage(KIRC::Engine *engine, const QTextCodec *codec, const QString &str); + + static void writeMessage(KIRC::Engine *engine, const QTextCodec *codec, + const QString &command, const QStringList &args, const QString &suffix); + + static void writeCtcpMessage(KIRC::Engine *engine, const QTextCodec *codec, + const QString &command, const QString &to, + const QString &ctcpMessage); + + static void writeCtcpMessage(KIRC::Engine *engine, const QTextCodec *codec, + const QString &command, const QString &to, const QString &suffix, + const QString &ctcpCommand, const QStringList &ctcpArgs = QStringList(), const QString &ctcpSuffix = QString::null ); + + Message(); + Message(const KIRC::Message &obj); + Message(const KIRC::Message *obj); + + ~Message(); + + inline const QString nickFromPrefix() const + { return Kopete::Message::unescape(KIRC::Entity::userNick(m_prefix)); } + + QString toString() const; + + /** \brief Returns true if the message command is numeric. + */ + bool isNumeric() const; + + /** \brief Message is valid if it was parsed correctly. + */ + bool isValid() const; + + /** \brief Writes internal message information about this message through kdDebug(). + */ + void dump() const; + + /** \brief Re-decodes the message with given codec. + */ + void decodeAgain( const QTextCodec *codec ); + + /** \brief The whole message as received. + */ + inline const QCString &raw() const + { return m_raw; } + + /** \brief Prefix of this message. + * + * Returns the prefix of the message. Note that it can be empty. + * + * Prefix is the server name or the nick name of the sender. + * + * message = [ ":" prefix SPACE ] command [ params ] crlf + * prefix = servername / ( nickname [ [ "!" user ] "@" host ] ) + */ + inline const QString &prefix() const + { return m_prefix; } + + /** \brief The command part of this message. + * + * Returns the command of this message. Can be numerical. + * + * Examples: "MODE", "PRIVMSG", 303, 001, ... + */ + inline const QString &command() const + { return m_command; } + + /** \brief The number of command arguments this message contains. + */ + inline size_t argsSize() const + { return m_args.size(); } + + /** \brief i:th command argument. + */ + inline const QString &arg(size_t i) const + { return m_args[i]; } + + /** \brief All command arguments. + */ + inline const QStringList &args() const + { return m_args; } + + /** \brief Message suffix. + */ + inline const QString &suffix() const + { return m_suffix; } + inline const QString &ctcpRaw() const + { return m_ctcpRaw; } + + inline bool hasCtcpMessage() const + { return m_ctcpMessage!=0; } + inline class KIRC::Message &ctcpMessage() const + { return *m_ctcpMessage; } + + static KIRC::Message parse(KIRC::Engine *engine, const QTextCodec *codec, bool *parseSuccess=0); + +private: + /** + * Contains the low level dequoted message. + */ + QCString m_raw; + + /** + * Contains the completely dequoted prefix. + */ + QString m_prefix; + /** + * Contains the completely dequoted command. + */ + QString m_command; + /** + * Contains the completely dequoted args. + */ + QStringList m_args; + /** + * Contains the completely dequoted suffix. + */ + QString m_suffix; + + /** + * If it is a message contains the completely dequoted rawCtcpLine. + * If it is a ctcp message contains the completely dequoted rawCtcpArgsLine. + */ + QString m_ctcpRaw; + + // low level quoting, message quoting + static QString quote(const QString &str); + static QString unquote(const QString &str); + + // ctcp level quoting + static QString ctcpQuote(const QString &str); + static QString ctcpUnquote(const QString &str); + + static bool extractCtcpCommand(QCString &str, QCString &ctcpline); + + static bool matchForIRCRegExp(const QCString &line, const QTextCodec *codec, KIRC::Message &message); + static bool matchForIRCRegExp(QRegExp ®exp, const QTextCodec *codec, const QCString &line, KIRC::Message &message); + + class KIRC::Message *m_ctcpMessage; + + static QRegExp m_IRCCommandType1; + #ifdef _IRC_STRICTNESS_ + static QRegExp m_IRCCommandType2; + #endif // _IRC_STRICTNESS_ + + static QRegExp m_IRCNumericCommand; +}; + +} + +#endif // KIRCMESSAGE_H |