X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=inline;f=include%2Fmode.h;h=940ed2144b34ab1b8863c9d3bb4e160f89eb25ad;hb=b4a174ee9c32d62ea6bf010e837e8c5b1c3d36a3;hp=fe02838b2fc80aef7b47d98deab905818e718cef;hpb=c6e40d36b42a7ebf832c3a57d2816a47ee9c9a76;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index fe02838b2..940ed2144 100644 --- a/include/mode.h +++ b/include/mode.h @@ -1,10 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2013-2016 Attila Molnar + * Copyright (C) 2012-2013, 2017-2021 Sadie Powell + * Copyright (C) 2012 Robby * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2004-2006, 2008 Craig Edwards - * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2008 Robin Burchell * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2008, 2010 Craig Edwards * * 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 @@ -95,7 +99,7 @@ class ParamModeBase; class CoreExport ModeHandler : public ServiceProvider { public: - typedef size_t Id; + typedef size_t Id; enum Class { @@ -133,7 +137,7 @@ class CoreExport ModeHandler : public ServiceProvider * 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; @@ -154,9 +158,12 @@ class CoreExport ModeHandler : public ServiceProvider /** The prefix rank required to unset this mode on channels. */ unsigned int ranktounset; + /** If non-empty then the syntax of the parameter for this mode. */ + std::string syntax; + 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 @@ -267,6 +274,7 @@ class CoreExport ModeHandler : public ServiceProvider * @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. @@ -283,10 +291,19 @@ class CoreExport ModeHandler : public ServiceProvider */ 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); @@ -304,7 +321,7 @@ class CoreExport ModeHandler : public ServiceProvider /** * 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); @@ -329,6 +346,9 @@ class CoreExport ModeHandler : public ServiceProvider return adding ? ranktoset : ranktounset; } + /** Retrieves the syntax of the parameter for this mode. */ + const std::string& GetSyntax() const { return syntax; } + friend class ModeParser; }; @@ -445,8 +465,12 @@ class CoreExport PrefixMode : public ModeHandler 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; }; @@ -458,8 +482,12 @@ class CoreExport SimpleUserModeHandler : public ModeHandler 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; }; @@ -538,8 +566,12 @@ class CoreExport ModeWatcher : public classbase class CoreExport ModeParser : public fakederef { public: + /** The maximum number of modes which can be created. */ static const ModeHandler::Id MODEID_MAX = 64; + /** The maximum length of a mode parameter. */ + static const size_t MODE_PARAM_MAX = 250; + /** Type of the container that maps mode names to ModeHandlers */ typedef TR1NS::unordered_map ModeHandlerMap; @@ -547,7 +579,7 @@ class CoreExport ModeParser : public fakederef private: /** Type of the container that maps mode names to ModeWatchers */ - typedef insp::flat_multimap ModeWatcherMap; + typedef insp::flat_multimap ModeWatcherMap; /** Last item in the ModeType enum */ @@ -649,7 +681,7 @@ class CoreExport ModeParser : public fakederef * * 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. */ @@ -706,7 +738,7 @@ class CoreExport ModeParser : public fakederef * @param user The source of the mode change, can be a server user. * @param targetchannel Channel to apply the mode change on. NULL if changing modes on a channel. * @param targetuser User to apply the mode change on. NULL if changing modes on a user. - * @param changelist Modes to change in form of a Modes::ChangeList. May not process + * @param changelist Modes to change in form of a Modes::ChangeList. May not process * the entire list due to MODE line length and max modes limitations. * @param flags Optional flags controlling how the mode change is processed, * defaults to MODE_NONE. @@ -725,11 +757,11 @@ class CoreExport ModeParser : public fakederef * is a channel mode change. * @param parameters List of strings describing the mode change to convert to a ChangeList. * Must be using the same format as the parameters of a MODE command. - * @param changelist ChangeList object to populate. - * @param beginindex Index of the first element that is part of the MODE list in the parameters - * container. Defaults to 1. - * @param endindex Index of the first element that is not part of the MODE list. By default, - * the entire container is considered part of the MODE list. + * @param changelist ChangeList object to populate. + * @param beginindex Index of the first element that is part of the MODE list in the parameters + * container. Defaults to 1. + * @param endindex Index of the first element that is not part of the MODE list. By default, + * the entire container is considered part of the MODE list. */ void ModeParamsToChangeList(User* user, ModeType type, const std::vector& parameters, Modes::ChangeList& changelist, unsigned int beginindex = 1, unsigned int endindex = UINT_MAX); @@ -743,7 +775,7 @@ class CoreExport ModeParser : public fakederef /** 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); @@ -760,7 +792,7 @@ class CoreExport ModeParser : public fakederef */ 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