2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2015 Attila Molnar <attilamolnar@hush.com>
6 * This file is part of InspIRCd. InspIRCd is free software: you can
7 * redistribute it and/or modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation, version 2.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 static const unsigned int MAX_CAPS = (sizeof(intptr_t) * 8) - 1;
27 static const intptr_t CAP_302_BIT = (intptr_t)1 << MAX_CAPS;
28 static const unsigned int MAX_VALUE_LENGTH = 100;
31 typedef LocalIntExt ExtItem;
36 /** Supports capability negotiation protocol v3.1, or none
40 /** Supports capability negotiation v3.2
45 class Manager : public DataProvider
49 : DataProvider(mod, "capmanager")
53 /** Register a client capability.
54 * Modules should call Capability::SetActive(true) instead of this method.
55 * @param cap Capability to register
57 virtual void AddCap(Capability* cap) = 0;
59 /** Unregister a client capability.
60 * Modules should call Capability::SetActive(false) instead of this method.
61 * @param cap Capability to unregister
63 virtual void DelCap(Capability* cap) = 0;
65 /** Find a capability by name
66 * @param name Capability to find
67 * @return Capability object pointer if found, NULL otherwise
69 virtual Capability* Find(const std::string& name) const = 0;
72 /** Represents a client capability.
74 * Capabilities offer extensions to the client to server protocol. They must be negotiated with clients before they have any effect on the protocol.
75 * Each cap must have a unique name that is used during capability negotiation.
77 * After construction the cap is ready to be used by clients without any further setup, like other InspIRCd services.
78 * The get() method accepts a user as parameter and can be used to check whether that user has negotiated usage of the cap. This is only known for local users.
80 * The cap module must be loaded for the capability to work. The IsRegistered() method can be used to query whether the cap is actually online or not.
81 * The capability can be deactivated and reactivated with the SetActive() method. Deactivated caps behave as if they don't exist.
83 * It is possible to implement special behavior by inheriting from this class and overriding some of its methods.
85 class Capability : public ServiceProvider, private dynamic_reference_base::CaptureHook
89 /** Bit allocated to this cap, undefined if the cap is unregistered
93 /** Extension containing all caps set by a user. NULL if the cap is unregistered.
97 /** True if the cap is active. Only active caps are registered in the manager.
101 /** Reference to the cap manager object
103 dynamic_reference<Manager> manager;
105 void OnCapture() CXX11_OVERRIDE
117 Ext AddToMask(Ext mask) const { return (mask | GetMask()); }
118 Ext DelFromMask(Ext mask) const { return (mask & (~GetMask())); }
119 Bit GetMask() const { return bit; }
121 friend class ManagerImpl;
124 /** Constructor, initializes the capability.
125 * Caps are active by default.
126 * @param mod Module providing the cap
127 * @param Name Raw name of the cap as used in the protocol (CAP LS, etc.)
129 Capability(Module* mod, const std::string& Name)
130 : ServiceProvider(mod, Name, SERVICE_CUSTOM)
132 , manager(mod, "capmanager")
142 void RegisterService() CXX11_OVERRIDE
144 manager.SetCaptureHook(this);
148 /** Check whether a user has the capability turned on.
149 * This method is safe to call if the cap is unregistered and will return false.
150 * @param user User to check
151 * @return True if the user is using this capability, false otherwise
153 bool get(User* user) const
157 Ext caps = extitem->get(user);
158 return (caps & GetMask());
161 /** Turn the capability on/off for a user. If the cap is not registered this method has no effect.
162 * @param user User to turn the cap on/off for
163 * @param val True to turn the cap on, false to turn it off
165 void set(User* user, bool val)
169 Ext curr = extitem->get(user);
170 extitem->set(user, (val ? AddToMask(curr) : DelFromMask(curr)));
173 /** Activate or deactivate the capability.
174 * If activating, the cap is marked as active and if the manager is available the cap is registered in the manager.
175 * If deactivating, the cap is marked as inactive and if it is registered, it will be unregistered.
176 * Users who had the cap turned on will have it turned off automatically.
177 * @param activate True to activate the cap, false to deactivate it
179 void SetActive(bool activate)
185 manager->AddCap(this);
187 manager->DelCap(this);
191 /** Get the name of the capability that's used in the protocol
192 * @return Name of the capability as used in the protocol
194 const std::string& GetName() const { return name; }
196 /** Check whether the capability is active. The cap must be active and registered to be used by users.
197 * @return True if the cap is active, false if it has been deactivated
199 bool IsActive() const { return active; }
201 /** Check whether the capability is registered
202 * The cap must be active and the manager must be available for a cap to be registered.
203 * @return True if the cap is registered in the manager, false otherwise
205 bool IsRegistered() const { return (extitem != NULL); }
207 /** Get the CAP negotiation protocol version of a user.
208 * The cap must be registered for this to return anything other than CAP_LEGACY.
209 * @param user User whose negotiation protocol version to query
210 * @return One of the Capability::Protocol enum indicating the highest supported capability negotiation protocol version
212 Protocol GetProtocol(LocalUser* user) const
214 return ((IsRegistered() && (extitem->get(user) & CAP_302_BIT)) ? CAP_302 : CAP_LEGACY);
217 /** Called when a user requests to turn this capability on or off.
218 * @param user User requesting to change the state of the cap
219 * @param add True if requesting to turn the cap on, false if requesting to turn it off
220 * @return True to allow the request, false to reject it
222 virtual bool OnRequest(LocalUser* user, bool add)
227 /** Called when a user requests a list of all capabilities and this capability is about to be included in the list.
228 * The default behavior always includes the cap in the list.
229 * @param user User querying a list capabilities
230 * @return True to add this cap to the list sent to the user, false to not list it
232 virtual bool OnList(LocalUser* user)
237 /** Query the value of this capability for a user
238 * @param user User who will get the value of the capability
239 * @return Value to show to the user. If NULL, the capability has no value (default).
241 virtual const std::string* GetValue(LocalUser* user) const