#ifndef __MODE_H
#define __MODE_H
-/* Forward declarations. */
-class User;
-
#include "ctables.h"
-#include "channels.h"
/**
* Holds the values for different type of modes
PARAM_ALWAYS
};
-/**
- * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
- * The pair contains an activity flag, true if the mode is set with the given parameter,
- * and the parameter of the mode (or the parameter provided) in the std::string.
- */
-typedef std::pair<bool,std::string> ModePair;
-
/** Each mode is implemented by ONE ModeHandler class.
* You must derive ModeHandler and add the child class to
* the list of modes handled by the ircd, using
* mode is expected to have a parameter, then this is
* equivalent to returning MODEACTION_DENY.
*/
-class CoreExport ModeHandler : public classbase
+class CoreExport ModeHandler : public providerbase
{
protected:
/**
/**
* The mode letter you're implementing.
*/
- const char mode;
+ char mode;
/** Mode prefix, or 0
*/
int levelrequired;
public:
- /** Module that created this mode. NULL for core modes */
- Module* const creator;
- /** Long-form name
- */
- const std::string name;
-
/**
* The constructor for ModeHandler initalizes the mode handler.
* The constructor of any class you derive from ModeHandler should
* @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL)
*/
ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type);
+ virtual CullResult cull();
virtual ~ModeHandler();
/**
* Returns true if the mode is a list mode
* Returns the mode character this handler handles.
* @return The mode character
*/
- char GetModeChar();
+ inline char GetModeChar() { return mode; }
/** For user modes, return the current parameter, if any
*/
*/
virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
- /**
- * When a remote server needs to bounce a set of modes, it will call this method for every mode
- * in the mode string to determine if the mode is set or not.
- * @param source of the mode change, this will be NULL for a server mode
- * @param dest Target user of the mode change, if this is a user mode
- * @param channel Target channel of the mode change, if this is a channel mode
- * @param parameter The parameter given for the mode change, or an empty string
- * @returns The first value of the pair should be true if the mode is set with the given parameter.
- * In the case of permissions modes such as channelmode +o, this should return true if the user given
- * as the parameter has the given privilage on the given channel. The string value of the pair will hold
- * the current setting for this mode set locally, when the bool is true, or, the parameter given.
- * This allows the local server to enforce our locally set parameters back to a remote server.
- */
- virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter);
-
/**
* When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
* Your mode handler should remove its user mode from the user by sending the appropriate server modes using
virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
};
+class CoreExport ParamChannelModeHandler : public ModeHandler
+{
+ public:
+ ParamChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
+ : ModeHandler(Creator, Name, modeletter, PARAM_SETONLY, MODETYPE_CHANNEL) {}
+ virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
+ /** Validate the parameter - you may change the value to normalize it. Return true if it is valid. */
+ virtual bool ParamValidate(std::string& parameter);
+};
+
/**
* The ModeWatcher class can be used to alter the behaviour of a mode implemented
* by the core or by another module. To use ModeWatcher, derive a class from it,
ModeType m_type;
public:
- Module* const creator;
+ ModuleRef creator;
/**
* The constructor initializes the mode and the mode type
*/
* parses client to server MODE strings for user and channel modes, and performs
* processing for the 004 mode list numeric, amongst other things.
*/
-class CoreExport ModeParser : public classbase
+class CoreExport ModeParser
{
private:
/** Mode handlers for each mode, to access a handler subtract
static bool PrefixComparison(ModeHandler* one, ModeHandler* two);
- /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
- */
- std::string BuildPrefixes();
-
- /** This returns the privilages of a user upon a channel, in the format of a mode change.
- * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
- * This is used by the core when cycling a user to refresh their hostname. You may use it for
- * similar purposes.
- * @param user The username to look up
- * @param channel The channel name to look up the privilages of the user for
- * @param nick_suffix true (the default) if you want nicknames in the mode string, for easy
- * use with the mode stacker, false if you just want the "avh" part of "avh nick nick nick".
- * @return The mode string.
+ /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or
+ * just the "@%+" part if the parameter false
*/
- std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
+ std::string BuildPrefixes(bool lettersAndModes = true);
};
#endif
projects / user / henk / code / inspircd.git / blobdiff