X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Firccap.h;h=f378a78e32314774d378aee23dcb28eac4c7c239;hp=147a7671cd0fa572bc5e32cd0a994c888a2021c0;hb=e38846f054ad1766f2e91992a57bbaffd33c7c06;hpb=c1cf157116de7fc3da96203aa6f03c38c7ebb650 diff --git a/src/common/irccap.h b/src/common/irccap.h index 147a7671..f378a78e 100644 --- a/src/common/irccap.h +++ b/src/common/irccap.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2018 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,8 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef IRCCAP_H -#define IRCCAP_H +#pragma once #include #include @@ -32,136 +31,142 @@ */ namespace IrcCap { -// NOTE: If you add or modify the constants below, update the knownCaps list. - -/** - * Account change notification. - * - * http://ircv3.net/specs/extensions/account-notify-3.1.html - */ -const QString ACCOUNT_NOTIFY = "account-notify"; - -/** - * Magic number for WHOX, used to ignore user-requested WHOX replies from servers - * - * If a user initiates a WHOX, there's no easy way to tell what fields were requested. It's - * simpler to not attempt to parse data from user-requested WHOX replies. - */ -const uint ACCOUNT_NOTIFY_WHOX_NUM = 369; - -/** - * Away change notification. - * - * http://ircv3.net/specs/extensions/away-notify-3.1.html - */ -const QString AWAY_NOTIFY = "away-notify"; - -/** - * Capability added/removed notification. - * - * This is implicitly enabled via CAP LS 302, and is here for servers that only partially - * support IRCv3.2. - * - * http://ircv3.net/specs/extensions/cap-notify-3.2.html - */ -const QString CAP_NOTIFY = "cap-notify"; - -/** - * Hostname/user changed notification. - * - * http://ircv3.net/specs/extensions/chghost-3.2.html - */ -const QString CHGHOST = "chghost"; - -/** - * Extended join information. - * - * http://ircv3.net/specs/extensions/extended-join-3.1.html - */ -const QString EXTENDED_JOIN = "extended-join"; - -/** - * Multiple mode prefixes in MODE and WHO replies. - * - * http://ircv3.net/specs/extensions/multi-prefix-3.1.html - */ -const QString MULTI_PREFIX = "multi-prefix"; - -/** - * SASL authentication. - * - * http://ircv3.net/specs/extensions/sasl-3.2.html - */ -const QString SASL = "sasl"; - -/** - * Userhost in names replies. - * - * http://ircv3.net/specs/extensions/userhost-in-names-3.2.html - */ -const QString USERHOST_IN_NAMES = "userhost-in-names"; - -/** - * Vendor-specific capabilities - */ -namespace Vendor { - -/** - * Twitch.tv membership message support - * - * User list in a channel can be quite large and often non required for bot users and is then optional. - * - * From Twitch.tv documentation: - * "Adds membership state event data. By default, we do not send this data to clients without this capability." - * - * https://dev.twitch.tv/docs/v5/guides/irc/#twitch-irc-capability-membership - */ -const QString TWITCH_MEMBERSHIP = "twitch.tv/membership"; - -/** - * Self message support, as recognized by ZNC. - * - * Some servers (e.g. Bitlbee) assume self-message support; ZNC requires a capability - * instead. As self-message is already implemented, there's little reason to not do this. - * - * More information in the IRCv3 commit that removed the 'self-message' capability. - * - * https://github.com/ircv3/ircv3-specifications/commit/1bfba47843c2526707c902034b3395af934713c8 - */ -const QString ZNC_SELF_MESSAGE = "znc.in/self-message"; -} // namespace Vendor - -/** - * List of capabilities currently implemented and requested during capability negotiation. - */ -const QStringList knownCaps = QStringList{ACCOUNT_NOTIFY, - AWAY_NOTIFY, - CAP_NOTIFY, - CHGHOST, - EXTENDED_JOIN, - MULTI_PREFIX, - SASL, - USERHOST_IN_NAMES, - Vendor::TWITCH_MEMBERSHIP, - Vendor::ZNC_SELF_MESSAGE}; -// NOTE: If you modify the knownCaps list, update the constants above as needed. - -/** - * SASL authentication mechanisms - * - * http://ircv3.net/specs/extensions/sasl-3.1.html - */ -namespace SaslMech { -/** - * PLAIN authentication, e.g. hashed password - */ -const QString PLAIN = "PLAIN"; - -/** - * EXTERNAL authentication, e.g. SSL certificate and keys - */ -const QString EXTERNAL = "EXTERNAL"; -} // namespace SaslMech -} // namespace IrcCap - -#endif // IRCCAP_H + // NOTE: If you add or modify the constants below, update the knownCaps list. + + /** + * Account change notification. + * + * http://ircv3.net/specs/extensions/account-notify-3.1.html + */ + const QString ACCOUNT_NOTIFY = "account-notify"; + + /** + * Magic number for WHOX, used to ignore user-requested WHOX replies from servers + * + * If a user initiates a WHOX, there's no easy way to tell what fields were requested. It's + * simpler to not attempt to parse data from user-requested WHOX replies. + */ + const uint ACCOUNT_NOTIFY_WHOX_NUM = 369; + + /** + * Away change notification. + * + * http://ircv3.net/specs/extensions/away-notify-3.1.html + */ + const QString AWAY_NOTIFY = "away-notify"; + + /** + * Capability added/removed notification. + * + * This is implicitly enabled via CAP LS 302, and is here for servers that only partially + * support IRCv3.2. + * + * http://ircv3.net/specs/extensions/cap-notify-3.2.html + */ + const QString CAP_NOTIFY = "cap-notify"; + + /** + * Hostname/user changed notification. + * + * http://ircv3.net/specs/extensions/chghost-3.2.html + */ + const QString CHGHOST = "chghost"; + + /** + * Extended join information. + * + * http://ircv3.net/specs/extensions/extended-join-3.1.html + */ + const QString EXTENDED_JOIN = "extended-join"; + + /** + * Multiple mode prefixes in MODE and WHO replies. + * + * http://ircv3.net/specs/extensions/multi-prefix-3.1.html + */ + const QString MULTI_PREFIX = "multi-prefix"; + + /** + * SASL authentication. + * + * http://ircv3.net/specs/extensions/sasl-3.2.html + */ + const QString SASL = "sasl"; + + /** + * Userhost in names replies. + * + * http://ircv3.net/specs/extensions/userhost-in-names-3.2.html + */ + const QString USERHOST_IN_NAMES = "userhost-in-names"; + + /** + * Server time for messages. + * + * https://ircv3.net/specs/extensions/server-time-3.2.html + */ + const QString SERVER_TIME = "server-time"; + + /** + * Vendor-specific capabilities + */ + namespace Vendor { + + /** + * Twitch.tv membership message support + * + * User list in a channel can be quite large and often non required for bot users and is then optional. + * + * From Twitch.tv documentation: + * "Adds membership state event data. By default, we do not send this data to clients without this capability." + * + * https://dev.twitch.tv/docs/v5/guides/irc/#twitch-irc-capability-membership + */ + const QString TWITCH_MEMBERSHIP = "twitch.tv/membership"; + + /** + * Self message support, as recognized by ZNC. + * + * Some servers (e.g. Bitlbee) assume self-message support; ZNC requires a capability + * instead. As self-message is already implemented, there's little reason to not do this. + * + * More information in the IRCv3 commit that removed the 'self-message' capability. + * + * https://github.com/ircv3/ircv3-specifications/commit/1bfba47843c2526707c902034b3395af934713c8 + */ + const QString ZNC_SELF_MESSAGE = "znc.in/self-message"; + } + + /** + * List of capabilities currently implemented and requested during capability negotiation. + */ + const QStringList knownCaps = QStringList{ACCOUNT_NOTIFY, + AWAY_NOTIFY, + CAP_NOTIFY, + CHGHOST, + EXTENDED_JOIN, + MULTI_PREFIX, + SASL, + USERHOST_IN_NAMES, + SERVER_TIME, + Vendor::TWITCH_MEMBERSHIP, + Vendor::ZNC_SELF_MESSAGE}; + // NOTE: If you modify the knownCaps list, update the constants above as needed. + + /** + * SASL authentication mechanisms + * + * http://ircv3.net/specs/extensions/sasl-3.1.html + */ + namespace SaslMech { + /** + * PLAIN authentication, e.g. hashed password + */ + const QString PLAIN = "PLAIN"; + + /** + * EXTERNAL authentication, e.g. SSL certificate and keys + */ + const QString EXTERNAL = "EXTERNAL"; + } +}