X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Firccap.h;h=46071cf1fb3124df0a3216f9c5f07acfbd4d09f2;hp=14c0ed7c9568715507d7dd62ee9d6d1128b595c6;hb=cc6e7c08709c4e761e2fd9c2e322751015497003;hpb=a2e096ed11221866f9707ad61265a9d359a21de3 diff --git a/src/common/irccap.h b/src/common/irccap.h index 14c0ed7c..46071cf1 100644 --- a/src/common/irccap.h +++ b/src/common/irccap.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 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 * @@ -32,122 +32,136 @@ */ 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"; - - /** - * 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 - }; - // 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 { - - /** - * Check if the given authentication mechanism is likely to be supported. - * - * @param[in] saslCapValue QString of SASL capability value, e.g. capValue(IrcCap::SASL) - * @param[in] saslMechanism Desired SASL mechanism - * @return True if mechanism supported or unknown, otherwise false - */ - inline bool maybeSupported(const QString &saslCapValue, const QString &saslMechanism) { return - ((saslCapValue.length() == 0) || (saslCapValue.contains(saslMechanism, Qt::CaseInsensitive))); } - // SASL mechanisms are only specified in capability values as part of SASL 3.2. In - // SASL 3.1, it's handled differently. If we don't know via capability value, assume it's - // supported to reduce the risk of breaking existing setups. - // See: http://ircv3.net/specs/extensions/sasl-3.1.html - // And: http://ircv3.net/specs/extensions/sasl-3.2.html - - /** - * PLAIN authentication, e.g. hashed password - */ - const QString PLAIN = "PLAIN"; - - /** - * EXTERNAL authentication, e.g. SSL certificate and keys - */ - const QString EXTERNAL = "EXTERNAL"; - } -} - -#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"; + +/** + * 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