Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Server Class Reference

Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. More...

#include <modules.h>

Inheritance diagram for Server:

Inheritance graph
[legend]
Collaboration diagram for Server:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Server ()
 Default constructor.

virtual ~Server ()
 Default destructor.

virtual void SendOpers (std::string s)
 Sends text to all opers.

virtual void Log (int level, std::string s)
 Writes a log string.

virtual void Send (int Socket, std::string s)
 Sends a line of text down a TCP/IP socket.

virtual void SendServ (int Socket, std::string s)
 Sends text from the server to a socket.

virtual void SendFrom (int Socket, userrec *User, std::string s)
 Sends text from a user to a socket.

virtual void SendTo (userrec *Source, userrec *Dest, std::string s)
 Sends text from a user to another user.

virtual void SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender)
 Sends text from a user to a channel (mulicast).

virtual bool CommonChannels (userrec *u1, userrec *u2)
 Returns true if two users share a common channel.

virtual void SendCommon (userrec *User, std::string text, bool IncludeSender)
 Sends text from a user to one or more channels (mulicast).

virtual void SendWallops (userrec *User, std::string text)
 Sends a WALLOPS message.

virtual bool IsNick (std::string nick)
 Returns true if a nick is valid.

virtual userrec * FindNick (std::string nick)
 Attempts to look up a nick and return a pointer to it.

virtual chanrec * FindChannel (std::string channel)
 Attempts to look up a channel and return a pointer to it.

virtual std::string ChanMode (userrec *User, chanrec *Chan)
 Attempts to look up a user's privilages on a channel.

virtual std::string GetServerName ()
 Returns the server name of the server where the module is loaded.

virtual std::string GetNetworkName ()
 Returns the network name, global to all linked servers.

virtual Admin GetAdmin ()
 Returns the information of the server as returned by the /ADMIN command.

virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
 Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.

virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams)
 Adds a command to the command table.

virtual void SendMode (char **parameters, int pcnt, userrec *user)
 Sends a servermode.

virtual void SendToModeMask (std::string modes, int flags, std::string text)
 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

virtual chanrec * Server::JoinUserToChannel (userrec *user, std::string cname, std::string key)
 Forces a user to join a channel.

virtual chanrec * Server::PartUserFromChannel (userrec *user, std::string cname, std::string reason)
 Forces a user to part a channel.

virtual void ChangeUserNick (userrec *user, std::string nickname)
 Forces a user nickchange.

virtual void QuitUser (userrec *user, std::string reason)
 Forces a user to quit with the specified reason.

Detailed Description

Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.

All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.

Definition at line 239 of file modules.h.

Constructor & Destructor Documentation

Server::Server (    ) 
 

Default constructor.

Creates a Server object.

Definition at line 130 of file modules.cpp. 

00131 {
00132 }

Server::~Server (    )  [virtual]
 

Default destructor.

Destroys a Server object.

Definition at line 134 of file modules.cpp. 

00135 {
00136 }

Member Function Documentation

void Server::AddCommand (  char *    cmd,
handlerfunc    f,
char    flags,
int    minparams
)  [virtual]
 

Adds a command to the command table.

This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:

typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.

Definition at line 174 of file modules.cpp.

References createcommand(). 

00175 {
00176         createcommand(cmd,f,flags,minparams);
00177 }

bool Server::AddExtendedMode (  char    modechar,
int    type,
bool    requires_oper,
int    params_when_on,
int    params_when_off
)  [virtual]
 

Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.

+x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.

Definition at line 275 of file modules.cpp.

References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. 

00276 {
00277         if (type == MT_SERVER)
00278         {
00279                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
00280                 return false;
00281         }
00282         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
00283         {
00284                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
00285                 return false;
00286         }
00287         if ((params_when_on>1) || (params_when_off>1))
00288         {
00289                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
00290                 return false;
00291         }
00292         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
00293 }

void Server::ChangeUserNick (  userrec *    user,
std::string    nickname
)  [virtual]
 

Forces a user nickchange.

This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.

Definition at line 158 of file modules.cpp. 

00159 {
00160         force_nickchange(user,nickname.c_str());
00161 }

std::string Server::ChanMode (  userrec *    User,
chanrec *    Chan
)  [virtual]
 

Attempts to look up a user's privilages on a channel.

This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.

Definition at line 253 of file modules.cpp. 

00254 {
00255         return cmode(User,Chan);
00256 }

bool Server::CommonChannels (  userrec *    u1,
userrec *    u2
)  [virtual]
 

Returns true if two users share a common channel.

This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.

Definition at line 216 of file modules.cpp. 

00217 {
00218         return (common_channels(u1,u2) != 0);
00219 }

chanrec * Server::FindChannel (  std::string    channel )  [virtual]
 

Attempts to look up a channel and return a pointer to it.

This function will return NULL if the channel does not exist.

Definition at line 248 of file modules.cpp. 

00249 {
00250         return FindChan(channel.c_str());
00251 }

userrec * Server::FindNick (  std::string    nick )  [virtual]
 

Attempts to look up a nick and return a pointer to it.

This function will return NULL if the nick does not exist.

Definition at line 243 of file modules.cpp. 

00244 {
00245         return Find(nick);
00246 }

Admin Server::GetAdmin (    )  [virtual]
 

Returns the information of the server as returned by the /ADMIN command.

See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.

Definition at line 268 of file modules.cpp. 

00269 {
00270         return Admin(getadminname(),getadminemail(),getadminnick());
00271 }

std::string Server::GetNetworkName (    )  [virtual]
 

Returns the network name, global to all linked servers.

Definition at line 263 of file modules.cpp. 

00264 {
00265         return getnetworkname();
00266 }

std::string Server::GetServerName (    )  [virtual]
 

Returns the server name of the server where the module is loaded.

Definition at line 258 of file modules.cpp. 

00259 {
00260         return getservername();
00261 }

bool Server::IsNick (  std::string    nick )  [virtual]
 

Returns true if a nick is valid.

Nicks for unregistered connections will return false.

Definition at line 238 of file modules.cpp. 

00239 {
00240         return (isnick(nick.c_str()) != 0);
00241 }

void Server::Log (  int    level,
std::string    s
)  [virtual]
 

Writes a log string.

This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.

Definition at line 169 of file modules.cpp. 

00170 {
00171         log(level,"%s",s.c_str());
00172 }

void Server::QuitUser (  userrec *    user,
std::string    reason
)  [virtual]
 

Forces a user to quit with the specified reason.

To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.

WARNING!

Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.

Definition at line 163 of file modules.cpp. 

00164 {
00165         kill_link(user,reason.c_str());
00166 }

void Server::Send (  int    Socket,
std::string    s
)  [virtual]
 

Sends a line of text down a TCP/IP socket.

This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.

Definition at line 184 of file modules.cpp. 

00185 {
00186         Write(Socket,"%s",s.c_str());
00187 }

void Server::SendChannel (  userrec *    User,
chanrec *    Channel,
std::string    s,
bool    IncludeSender
)  [virtual]
 

Sends text from a user to a channel (mulicast).

This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).

Definition at line 204 of file modules.cpp. 

00205 {
00206         if (IncludeSender)
00207         {
00208                 WriteChannel(Channel,User,"%s",s.c_str());
00209         }
00210         else
00211         {
00212                 ChanExceptSender(Channel,User,"%s",s.c_str());
00213         }
00214 }

void Server::SendCommon (  userrec *    User,
std::string    text,
bool    IncludeSender
)  [virtual]
 

Sends text from a user to one or more channels (mulicast).

This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.

Definition at line 221 of file modules.cpp. 

00222 {
00223         if (IncludeSender)
00224         {
00225                 WriteCommon(User,"%s",text.c_str());
00226         }
00227         else
00228         {
00229                 WriteCommonExcept(User,"%s",text.c_str());
00230         }
00231 }

void Server::SendFrom (  int    Socket,
userrec *    User,
std::string    s
)  [virtual]
 

Sends text from a user to a socket.

This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)

Definition at line 194 of file modules.cpp. 

00195 {
00196         WriteFrom(Socket,User,"%s",s.c_str());
00197 }

void Server::SendMode (  char **    parameters,
int    pcnt,
userrec *    user
)  [virtual]
 

Sends a servermode.

you must format the parameters array with the target, modes and parameters for those modes.

For example:

char *modes[3];

modes[0] = ChannelName;

modes[1] = "+o";

modes[2] = user->nick;

Srv->SendMode(modes,3,user);

The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!

Definition at line 179 of file modules.cpp.

References server_mode(). 

00180 {
00181         server_mode(parameters,pcnt,user);
00182 }

void Server::SendOpers (  std::string    s )  [virtual]
 

Sends text to all opers.

This method sends a server notice to all opers with the usermode +s.

Definition at line 138 of file modules.cpp. 

00139 {
00140         WriteOpers("%s",s.c_str());
00141 }

void Server::SendServ (  int    Socket,
std::string    s
)  [virtual]
 

Sends text from the server to a socket.

This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)

Definition at line 189 of file modules.cpp. 

00190 {
00191         WriteServ(Socket,"%s",s.c_str());
00192 }

void Server::SendTo (  userrec *    Source,
userrec *    Dest,
std::string    s
)  [virtual]
 

Sends text from a user to another user.

This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)

Definition at line 199 of file modules.cpp. 

00200 {
00201         WriteTo(Source,Dest,"%s",s.c_str());
00202 }

void Server::SendToModeMask (  std::string    modes,
int    flags,
std::string    text
)  [virtual]
 

Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:

Serv->SendToModeMask("xi", WM_OR, "m00");

Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.

Definition at line 143 of file modules.cpp. 

00144 {
00145         WriteMode(modes.c_str(),flags,"%s",text.c_str());
00146 }

void Server::SendWallops (  userrec *    User,
std::string    text
)  [virtual]
 

Sends a WALLOPS message.

This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.

Definition at line 233 of file modules.cpp. 

00234 {
00235         WriteWallOps(User,"%s",text.c_str());
00236 }

virtual chanrec* Server::Server::JoinUserToChannel (  userrec *    user,
std::string    cname,
std::string    key
)  [virtual]
 

Forces a user to join a channel.

This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.

virtual chanrec* Server::Server::PartUserFromChannel (  userrec *    user,
std::string    cname,
std::string    reason
)  [virtual]
 

Forces a user to part a channel.

This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.

The documentation for this class was generated from the following files:
Generated on Tue Apr 6 21:14:13 2004 for InspIRCd by doxygen1.3-rc3