qtui: Fix missing default value for backlog fetching
[quassel.git] / src / common / irccap.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #pragma once
22
23 #include <QString>
24 #include <QStringList>
25
26 // Why a namespace instead of a class?  Seems to be a better fit for C++ than a 'static' class, as
27 // compared to C# or Java.  However, feel free to change if needed.
28 // See https://stackoverflow.com/questions/482745/namespaces-for-enum-types-best-practices
29 /**
30  * IRCv3 capability names and values
31  */
32 namespace IrcCap {
33
34     // NOTE: If you add or modify the constants below, update the knownCaps list.
35
36     /**
37      * Account change notification.
38      *
39      * http://ircv3.net/specs/extensions/account-notify-3.1.html
40      */
41     const QString ACCOUNT_NOTIFY = "account-notify";
42
43     /**
44      * Magic number for WHOX, used to ignore user-requested WHOX replies from servers
45      *
46      * If a user initiates a WHOX, there's no easy way to tell what fields were requested.  It's
47      * simpler to not attempt to parse data from user-requested WHOX replies.
48      */
49     const uint ACCOUNT_NOTIFY_WHOX_NUM = 369;
50
51     /**
52      * Away change notification.
53      *
54      * http://ircv3.net/specs/extensions/away-notify-3.1.html
55      */
56     const QString AWAY_NOTIFY = "away-notify";
57
58     /**
59      * Capability added/removed notification.
60      *
61      * This is implicitly enabled via CAP LS 302, and is here for servers that only partially
62      * support IRCv3.2.
63      *
64      * http://ircv3.net/specs/extensions/cap-notify-3.2.html
65      */
66     const QString CAP_NOTIFY = "cap-notify";
67
68     /**
69      * Hostname/user changed notification.
70      *
71      * http://ircv3.net/specs/extensions/chghost-3.2.html
72      */
73     const QString CHGHOST = "chghost";
74
75     /**
76      * Extended join information.
77      *
78      * http://ircv3.net/specs/extensions/extended-join-3.1.html
79      */
80     const QString EXTENDED_JOIN = "extended-join";
81
82     /**
83      * Multiple mode prefixes in MODE and WHO replies.
84      *
85      * http://ircv3.net/specs/extensions/multi-prefix-3.1.html
86      */
87     const QString MULTI_PREFIX = "multi-prefix";
88
89     /**
90      * SASL authentication.
91      *
92      * http://ircv3.net/specs/extensions/sasl-3.2.html
93      */
94     const QString SASL = "sasl";
95
96     /**
97      * Userhost in names replies.
98      *
99      * http://ircv3.net/specs/extensions/userhost-in-names-3.2.html
100      */
101     const QString USERHOST_IN_NAMES = "userhost-in-names";
102
103     /**
104      * Server time for messages.
105      *
106      * https://ircv3.net/specs/extensions/server-time-3.2.html
107      */
108     const QString SERVER_TIME = "server-time";
109
110     /**
111      * Vendor-specific capabilities
112      */
113     namespace Vendor {
114
115         /**
116          * Twitch.tv membership message support
117          *
118          * User list in a channel can be quite large and often non required for bot users and is then optional.
119          *
120          * From Twitch.tv documentation:
121          * "Adds membership state event data. By default, we do not send this data to clients without this capability."
122          *
123          * https://dev.twitch.tv/docs/v5/guides/irc/#twitch-irc-capability-membership
124          */
125         const QString TWITCH_MEMBERSHIP = "twitch.tv/membership";
126
127         /**
128          * Self message support, as recognized by ZNC.
129          *
130          * Some servers (e.g. Bitlbee) assume self-message support; ZNC requires a capability
131          * instead.  As self-message is already implemented, there's little reason to not do this.
132          *
133          * More information in the IRCv3 commit that removed the 'self-message' capability.
134          *
135          * https://github.com/ircv3/ircv3-specifications/commit/1bfba47843c2526707c902034b3395af934713c8
136          */
137         const QString ZNC_SELF_MESSAGE = "znc.in/self-message";
138     }
139
140     /**
141      * List of capabilities currently implemented and requested during capability negotiation.
142      */
143     const QStringList knownCaps = QStringList{ACCOUNT_NOTIFY,
144                                               AWAY_NOTIFY,
145                                               CAP_NOTIFY,
146                                               CHGHOST,
147                                               EXTENDED_JOIN,
148                                               MULTI_PREFIX,
149                                               SASL,
150                                               USERHOST_IN_NAMES,
151                                               SERVER_TIME,
152                                               Vendor::TWITCH_MEMBERSHIP,
153                                               Vendor::ZNC_SELF_MESSAGE};
154     // NOTE: If you modify the knownCaps list, update the constants above as needed.
155
156     /**
157      * SASL authentication mechanisms
158      *
159      * http://ircv3.net/specs/extensions/sasl-3.1.html
160      */
161     namespace SaslMech {
162         /**
163          * PLAIN authentication, e.g. hashed password
164          */
165         const QString PLAIN = "PLAIN";
166
167         /**
168          * EXTERNAL authentication, e.g. SSL certificate and keys
169          */
170         const QString EXTERNAL = "EXTERNAL";
171     }
172 }