/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012-2013, 2017-2021 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- * Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
- * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
class CoreExport ModeHandler : public ServiceProvider
{
public:
- typedef size_t Id;
+ typedef size_t Id;
enum Class
{
* inside the mode parser as in the 1.0 api,
* so the only use of this value (along with
* IsListMode()) is for the core to determine
- * wether your module can produce 'lists' or not
+ * whether your module can produce 'lists' or not
* (e.g. banlists, etc)
*/
bool list;
public:
/**
- * The constructor for ModeHandler initalizes the mode handler.
+ * The constructor for ModeHandler initializes the mode handler.
* The constructor of any class you derive from ModeHandler should
* probably call this constructor with the parameters set correctly.
* @param me The module which created this mode
* @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
*/
virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
+
/**
* If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE \#channel +modechar
* without any parameter or other modes in the command.
*/
virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
+ /** Called when a user attempts to set a mode and the parameter is invalid.
+ * @param user The user issuing the mode change
+ * @param targetchannel Either the channel target or NULL if changing a user mode.
+ * @param targetuser Either the user target or NULL if changing a channel mode.
+ * @param parameter The invalid parameter.
+ */
+ virtual void OnParameterInvalid(User* user, Channel* targetchannel, User* targetuser, const std::string& parameter);
+
+
/**
* If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
* @param user The user issuing the command
- * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
+ * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
*/
virtual void DisplayEmptyList(User* user, Channel* channel);
/**
* When a MODETYPE_USER mode handler is being removed, the core will call this method for every user on the server.
- * The usermode will be removed using the appropiate server mode using InspIRCd::SendMode().
+ * The usermode will be removed using the appropriate server mode using InspIRCd::SendMode().
* @param user The user which the server wants to remove your mode from
*/
void RemoveMode(User* user);
class CoreExport SimpleUserModeHandler : public ModeHandler
{
public:
- SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter)
- : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {}
+ SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false)
+ : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER)
+ {
+ oper = operonly;
+ }
+
ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE;
};
class CoreExport SimpleChannelModeHandler : public ModeHandler
{
public:
- SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
- : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {}
+ SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false)
+ : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL)
+ {
+ oper = operonly;
+ }
+
ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE;
};
private:
/** Type of the container that maps mode names to ModeWatchers
*/
- typedef insp::flat_multimap<std::string, ModeWatcher*> ModeWatcherMap;
+ typedef insp::flat_multimap<std::string, ModeWatcher*> ModeWatcherMap;
/** Last item in the ModeType enum
*/
*
* host.name -> *!*\@host.name
*
- * ident@host.name -> *!ident\@host.name
+ * ident\@host.name -> *!ident\@host.name
*
* This method can be used on both IPV4 and IPV6 user masks.
*/
/** Find the mode handler for a given mode and type.
* @param modeletter mode letter to search for
* @param mt type of mode to search for, user or channel
- * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
+ * @returns a pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode
*/
ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
*/
PrefixMode* FindPrefix(unsigned const char pfxletter);
- /** Generates a list of modes, comma seperated by type:
+ /** Generates a list of modes, comma separated by type:
* 1; Listmodes EXCEPT those with a prefix
* 2; Modes that take a param when adding or removing
* 3; Modes that only take a param when adding
projects / user / henk / code / inspircd.git / blobdiff