Add 'twitch.tv/membership' capability for Twitch.tv

[quassel.git] / src / common / irccap.h

diff --git a/src/common/irccap.h b/src/common/irccap.h
index 3398ada..c3fd5bd 100644 (file)
--- a/src/common/irccap.h
+++ b/src/common/irccap.h
@@ -41,6 +41,14 @@ namespace IrcCap {
      */
     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.
      *
@@ -58,6 +66,13 @@ namespace IrcCap {
      */
     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.
      *
@@ -86,6 +101,36 @@ namespace IrcCap {
      */
     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";
+    }
+
     /**
      * List of capabilities currently implemented and requested during capability negotiation.
      */
@@ -93,10 +138,13 @@ namespace IrcCap {
             ACCOUNT_NOTIFY,
             AWAY_NOTIFY,
             CAP_NOTIFY,
+            CHGHOST,
             EXTENDED_JOIN,
             MULTI_PREFIX,
             SASL,
-            USERHOST_IN_NAMES
+            USERHOST_IN_NAMES,
+            Vendor::TWITCH_MEMBERSHIP,
+            Vendor::ZNC_SELF_MESSAGE
     };
     // NOTE: If you modify the knownCaps list, update the constants above as needed.
 
@@ -106,22 +154,6 @@ namespace IrcCap {
      * 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
          */