#include <mode.h>

Inheritance diagram for ModeParser:

Public Types
enum	ModeProcessFlags { MODE_NONE = 0, MODE_MERGE = 1, MODE_LOCALONLY = 2, MODE_CHECKACCESS = 4 }

typedef TR1NS::unordered_map< std::string, ModeHandler *, irc::insensitive, irc::StrHashComp >	ModeHandlerMap

typedef std::vector< ListModeBase * >	ListModeList

typedef std::vector< PrefixMode * >	PrefixModeList

typedef unsigned int	ModeProcessFlag

Public Member Functions
const Modes::ChangeList &	GetLastChangeList () const

void	AddMode (ModeHandler *mh)

bool	DelMode (ModeHandler *mh)

void	AddModeWatcher (ModeWatcher *mw)

bool	DelModeWatcher (ModeWatcher *mw)

void	Process (User user, Channel targetchannel, User *targetuser, Modes::ChangeList &changelist, ModeProcessFlag flags=MODE_NONE)

unsigned int	ProcessSingle (User user, Channel targetchannel, User *targetuser, Modes::ChangeList &changelist, ModeProcessFlag flags=MODE_NONE, unsigned int beginindex=0)

void	ModeParamsToChangeList (User *user, ModeType type, const std::vector< std::string > &parameters, Modes::ChangeList &changelist, unsigned int beginindex=1, unsigned int endindex=UINT_MAX)

ModeHandler *	FindMode (const std::string &modename, ModeType mt)

ModeHandler *	FindMode (unsigned const char modeletter, ModeType mt)

PrefixMode *	FindPrefixMode (unsigned char modeletter)

PrefixMode *	FindPrefix (unsigned const char pfxletter)

std::string	GiveModeList (ModeType mt)

std::string	BuildPrefixes (bool lettersAndModes=true)

const ListModeList &	GetListModes () const

const PrefixModeList &	GetPrefixModes () const

const ModeHandlerMap &	GetModes (ModeType mt) const

void	ShowListModeList (User user, Channel chan, ModeHandler *mh)

Public Member Functions inherited from fakederef< ModeParser >
ModeParser *	operator-> ()

Static Public Member Functions
static bool	IsModeChar (char chr)

static void	CleanMask (std::string &mask)

Static Public Attributes
static const ModeHandler::Id	MODEID_MAX = 64

static const size_t	MODE_PARAM_MAX = 250

Detailed Description

The mode parser handles routing of modes and handling of mode strings. It marshalls, controls and maintains both ModeWatcher and ModeHandler classes, parses client to server MODE strings for user and channel modes, and performs processing for the 004 mode list numeric, amongst other things.

Member Typedef Documentation

◆ ModeHandlerMap

typedef TR1NS::unordered_map<std::string, ModeHandler*, irc::insensitive, irc::StrHashComp> ModeParser::ModeHandlerMap

Type of the container that maps mode names to ModeHandlers

Member Enumeration Documentation

◆ ModeProcessFlags

enum ModeParser::ModeProcessFlags

Enumerator
MODE_NONE	If only this flag is specified, the mode change will be global and parameter modes will have their parameters explicitly set (not merged). This is the default.
MODE_MERGE	If this flag is set then the parameters of non-listmodes will be merged according to their conflict resolution rules. Does not affect user modes, channel modes without a parameter and listmodes.
MODE_LOCALONLY	If this flag is set then the linking module will ignore the mode change and not send it to other servers. The mode change will be processed locally and sent to local user(s) as usual.
MODE_CHECKACCESS	If this flag is set then the mode change will be subject to access checks. For more information see the documentation of the PrefixMode class, ModeHandler::ranktoset and ModeHandler::AccessCheck(). Modules may explicitly allow a mode change regardless of this flag by returning MOD_RES_ALLOW from the OnPreMode hook. Only affects channel mode changes.

Member Function Documentation

◆ AddMode()

void ModeParser::AddMode ( ModeHandler * mh )

Add a mode to the mode parser. Throws a ModuleException if the mode cannot be added.

◆ AddModeWatcher()

void ModeParser::AddModeWatcher ( ModeWatcher * mw )

Add a mode watcher. A mode watcher is triggered before and after a mode handler is triggered. See the documentation of class ModeWatcher for more information.

Parameters

mw	The ModeWatcher you want to add

◆ BuildPrefixes()

std::string ModeParser::BuildPrefixes ( bool lettersAndModes = true )

This returns the PREFIX=(ohv)%+ section of the 005 numeric, or just the "@%+" part if the parameter false

◆ CleanMask()

void ModeParser::CleanMask ( std::string & mask )

static

Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. E.g.

nick -> nick!*@*

nick!ident -> [email protected]*

host.name -> !@host.name

ident[email protected]@hos[email protected]t.nam[email protected]e -> *[email protected]

This method can be used on both IPV4 and IPV6 user masks.

◆ DelMode()

bool ModeParser::DelMode ( ModeHandler * mh )

Delete a mode from the mode parser. When a mode is deleted, the mode handler will be called for every user (if it is a user mode) or for every channel (if it is a channel mode) to unset the mode on all objects. This prevents modes staying in the system which no longer exist.

Parameters

mh	The mode handler to remove

Returns: True if the mode was successfully removed.

◆ DelModeWatcher()

bool ModeParser::DelModeWatcher ( ModeWatcher * mw )

Delete a mode watcher. A mode watcher is triggered before and after a mode handler is triggered. See the documentation of class ModeWatcher for more information.

Parameters

mw	The ModeWatcher you want to delete

Returns: True if the ModeWatcher was deleted correctly

◆ FindMode() [1/2]

ModeHandler * ModeParser::FindMode	(	const std::string &	modename,
		ModeType	mt
	)

Find the mode handler for a given mode name and type.

Parameters

modename	The mode name to search for.
mt	Type of mode to search for, user or channel.

Returns: A pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode name.

◆ FindMode() [2/2]

ModeHandler * ModeParser::FindMode	(	unsigned const char	modeletter,
		ModeType	mt
	)

Find the mode handler for a given mode and type.

Parameters

modeletter	mode letter to search for
mt	type of mode to search for, user or channel

Returns: a pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode

◆ FindPrefix()

PrefixMode * ModeParser::FindPrefix ( unsigned const char pfxletter )

Find a mode handler by its prefix. If there is no mode handler with the given prefix, NULL will be returned.

Parameters

pfxletter The prefix to find, e.g. '@'

Returns: The mode handler which handles this prefix, or NULL if there is none.

◆ FindPrefixMode()

PrefixMode * ModeParser::FindPrefixMode ( unsigned char modeletter )

Find the mode handler for the given prefix mode

Parameters

modeletter The mode letter to search for

Returns: A pointer to the PrefixMode or NULL if the mode wasn't found or it isn't a prefix mode

◆ GetLastChangeList()

const Modes::ChangeList& ModeParser::GetLastChangeList ( ) const

inline

Gets the last mode change to be processed.

◆ GetListModes()

const ListModeList& ModeParser::GetListModes ( ) const

inline

Get a list of all mode handlers that inherit from ListModeBase

Returns: A list containing ListModeBase modes

◆ GetModes()

const ModeHandlerMap& ModeParser::GetModes ( ModeType mt ) const

inline

Get a mode name -> ModeHandler* map containing all modes of the given type

Parameters

mt	Type of modes to return, MODETYPE_USER or MODETYPE_CHANNEL

Returns: A map of mode handlers of the given type

◆ GetPrefixModes()

const PrefixModeList& ModeParser::GetPrefixModes ( ) const

inline

Get a list of all prefix modes

Returns: A list containing all prefix modes

◆ GiveModeList()

std::string ModeParser::GiveModeList ( ModeType mt )

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 4; Modes that dont take a param

◆ ModeParamsToChangeList()

void ModeParser::ModeParamsToChangeList	(	User *	user,
		ModeType	type,
		const std::vector< std::string > &	parameters,
		Modes::ChangeList &	changelist,
		unsigned int	beginindex = `1`,
		unsigned int	endindex = `UINT_MAX`
	)

Turn a list of parameters compatible with the format of the MODE command into Modes::ChangeList form. All modes are processed, regardless of max modes. Unknown modes are skipped.

Parameters

user	The source of the mode change, can be a server user. Error numerics are sent to this user.
type	MODETYPE_USER if this is a user mode change or MODETYPE_CHANNEL if this is a channel mode change.
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.
changelist	ChangeList object to populate.
beginindex	Index of the first element that is part of the MODE list in the parameters container. Defaults to 1.
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.

◆ Process()

void ModeParser::Process	(	User *	user,
		Channel *	targetchannel,
		User *	targetuser,
		Modes::ChangeList &	changelist,
		ModeProcessFlag	flags = `MODE_NONE`
	)

Process a list of mode changes entirely. If the mode changes do not fit into one MODE line then multiple MODE lines are generated.

Parameters

user	The source of the mode change, can be a server user.
targetchannel	Channel to apply the mode change on. NULL if changing modes on a channel.
targetuser	User to apply the mode change on. NULL if changing modes on a user.
changelist	Modes to change in form of a Modes::ChangeList.
flags	Optional flags controlling how the mode change is processed, defaults to MODE_NONE.

◆ ProcessSingle()

unsigned int ModeParser::ProcessSingle	(	User *	user,
		Channel *	targetchannel,
		User *	targetuser,
		Modes::ChangeList &	changelist,
		ModeProcessFlag	flags = `MODE_NONE`,
		unsigned int	beginindex = `0`
	)

Process a single MODE line's worth of mode changes, taking max modes and line length limits into consideration. Return value indicates how many modes were processed.

Parameters

user	The source of the mode change, can be a server user.
targetchannel	Channel to apply the mode change on. NULL if changing modes on a channel.
targetuser	User to apply the mode change on. NULL if changing modes on a user.
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.
flags	Optional flags controlling how the mode change is processed, defaults to MODE_NONE.
beginindex	Index of the first element in changelist to process. Mode changes before the element with this index are ignored.

Returns: Number of mode changes processed from changelist.

◆ ShowListModeList()

void ModeParser::ShowListModeList	(	User *	user,
		Channel *	chan,
		ModeHandler *	mh
	)

Show the list of a list mode to a user. Modules can deny the listing.

Parameters

user	User to show the list to.
chan	Channel to show the list of.
mh	List mode to show the list of.

Member Data Documentation

◆ list

std::vector<ListModeBase*> ModeParser::list

List of mode handlers that inherit from ListModeBase

◆ MODE_PARAM_MAX

const size_t ModeParser::MODE_PARAM_MAX = 250

static

The maximum length of a mode parameter.

◆ MODEID_MAX

const ModeHandler::Id ModeParser::MODEID_MAX = 64

static

The maximum number of modes which can be created.

◆ prefix

std::vector<PrefixMode*> ModeParser::prefix

List of mode handlers that inherit from PrefixMode

The documentation for this class was generated from the following files:

include/mode.h
src/mode.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ModeHandlerMap

Member Enumeration Documentation

◆ ModeProcessFlags

Member Function Documentation

◆ AddMode()

◆ AddModeWatcher()

◆ BuildPrefixes()

◆ CleanMask()

◆ DelMode()

◆ DelModeWatcher()

◆ FindMode() [1/2]

◆ FindMode() [2/2]

◆ FindPrefix()

◆ FindPrefixMode()

◆ GetLastChangeList()

◆ GetListModes()

◆ GetModes()

◆ GetPrefixModes()

◆ GiveModeList()

◆ ModeParamsToChangeList()

◆ Process()

◆ ProcessSingle()

◆ ShowListModeList()

Member Data Documentation

◆ list

◆ MODE_PARAM_MAX

◆ MODEID_MAX

◆ prefix