Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class 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.
ServerConfig * GetConfig ()
 Obtains a pointer to the server's ServerConfig object.
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 SendChannelServerNotice (std::string ServName, chanrec *Channel, std::string text)
 Writes text to a channel, but from a server, including all.
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 int CountUsers (chanrec *c)
 Returns a count of the number of users on a channel.
virtual userrec * FindNick (std::string nick)
 Attempts to look up a nick and return a pointer to it.
virtual userrec * FindDescriptor (int socket)
 Attempts to look up a nick using the file descriptor associated with that nick.
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 bool IsOnChannel (userrec *User, chanrec *Chan)
 Checks if a user is 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 std::string GetServerDescription ()
 Returns the server description string of the local server.
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.
virtual bool AddExtendedListMode (char modechar)
 Adds an extended mode letter which is parsed by a module and handled in a list fashion.
virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source)
 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 * JoinUserToChannel (userrec *user, std::string cname, std::string key)
 Forces a user to join a channel.
virtual chanrec * 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.
virtual bool MatchText (std::string sliteral, std::string spattern)
 Matches text against a glob pattern.
virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)
 Calls the handler for a command, either implemented by the core or by another module.
virtual bool IsValidModuleCommand (std::string commandname, int pcnt, userrec *user)
virtual void ChangeHost (userrec *user, std::string host)
 Change displayed hostname of a user.
virtual void ChangeGECOS (userrec *user, std::string gecos)
 Change GECOS (fullname) of a user.
virtual bool IsUlined (std::string server)
 Returns true if the servername you give is ulined.
virtual chanuserlist GetUsers (chanrec *chan)
 Fetches the userlist of a channel.
virtual bool UserToPseudo (userrec *user, std::string message)
 Remove a user's connection to the irc server, but leave their client in existence in the user hash.
virtual bool PseudoToUser (userrec *alive, userrec *zombie, std::string message)
 This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.
virtual void AddGLine (long duration, std::string source, std::string reason, std::string hostmask)
 Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
virtual void AddQLine (long duration, std::string source, std::string reason, std::string nickname)
 Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
virtual void AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)
 Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
virtual void AddKLine (long duration, std::string source, std::string reason, std::string hostmask)
 Adds a K-line The K-line is enforced as soon as it is added.
virtual void AddELine (long duration, std::string source, std::string reason, std::string hostmask)
 Adds a E-line The E-line is enforced as soon as it is added.
virtual bool DelGLine (std::string hostmask)
 Deletes a G-Line from all servers on the mesh.
virtual bool DelQLine (std::string nickname)
 Deletes a Q-Line from all servers on the mesh.
virtual bool DelZLine (std::string ipaddr)
 Deletes a Z-Line from all servers on the mesh.
virtual bool DelKLine (std::string hostmask)
 Deletes a local K-Line.
virtual bool DelELine (std::string hostmask)
 Deletes a local E-Line.
virtual long CalcDuration (std::string duration)
 Calculates a duration This method will take a string containing a formatted duration (e.g.
virtual bool IsValidMask (std::string mask)
 Returns true if a nick!ident string is correctly formatted, false if otherwise.
virtual Module * FindModule (std::string name)
 This function finds a module by name.
virtual void AddSocket (InspSocket *sock)
 Adds a class derived from InspSocket to the server's socket engine.
virtual void DelSocket (InspSocket *sock)
 Deletes a class derived from InspSocket from the server's socket engine.
virtual void RehashServer ()

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 1096 of file modules.h.

Constructor & Destructor Documentation

Server::Server (   ) 
 

Default constructor.

Creates a Server object.

Definition at line 305 of file modules.cpp.

00306 {
00307 }

Server::~Server (   )  [virtual]
 

Default destructor.

Destroys a Server object.

Definition at line 309 of file modules.cpp.

00310 {
00311 }

Member Function Documentation

void Server::AddCommand (  char *  cmd,
handlerfunc  f,
char  flags,
int  minparams,
char *  source
)  [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'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded.

Definition at line 411 of file modules.cpp.

References createcommand().

00412 {
00413         createcommand(cmd,f,flags,minparams,source);
00414 }

void Server::AddELine (  long  duration,
std::string  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Adds a E-line The E-line is enforced as soon as it is added.

The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.

Definition at line 655 of file modules.cpp.

References add_eline().

00656 {
00657         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00658 }

bool Server::AddExtendedListMode (  char  modechar  )  [virtual]
 

Adds an extended mode letter which is parsed by a module and handled in a list fashion.

This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:

(1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL

(2) They always take exactly one parameter when being added or removed

(3) They can be set multiple times, usually on users in channels

(4) The mode and its parameter are NOT stored in the channels modes structure

It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.

Definition at line 579 of file modules.cpp.

References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.

00580 {
00581         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
00582         if (res)
00583                 ModeMakeList(modechar);
00584         return res;
00585 }

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 551 of file modules.cpp.

References DEBUG, DoAddExtendedMode(), log(), MT_CLIENT, and MT_SERVER.

00552 {
00553         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
00554         {
00555                 if (type == MT_SERVER)
00556                 {
00557                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
00558                         return false;
00559                 }
00560                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
00561                 {
00562                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
00563                         return false;
00564                 }
00565                 if ((params_when_on>1) || (params_when_off>1))
00566                 {
00567                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
00568                         return false;
00569                 }
00570                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
00571         }
00572         else
00573         {
00574                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
00575         }
00576         return false;
00577 }

void Server::AddGLine (  long  duration,
std::string  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.

The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.

Definition at line 635 of file modules.cpp.

References add_gline().

00636 {
00637         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00638 }

void Server::AddKLine (  long  duration,
std::string  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Adds a K-line The K-line is enforced as soon as it is added.

The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.

Definition at line 650 of file modules.cpp.

References add_kline().

00651 {
00652         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00653 }

void Server::AddQLine (  long  duration,
std::string  source,
std::string  reason,
std::string  nickname
)  [virtual]
 

Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.

The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.

Definition at line 640 of file modules.cpp.

References add_qline().

00641 {
00642         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
00643 }

void Server::AddSocket (  InspSocket *  sock  )  [virtual]
 

Adds a class derived from InspSocket to the server's socket engine.

Definition at line 313 of file modules.cpp.

References module_sockets.

00314 {
00315         module_sockets.push_back(sock);
00316 }

void Server::AddZLine (  long  duration,
std::string  source,
std::string  reason,
std::string  ipaddr
)  [virtual]
 

Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.

The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.

Definition at line 645 of file modules.cpp.

References add_zline().

00646 {
00647         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
00648 }

long Server::CalcDuration (  std::string  duration  )  [virtual]
 

Calculates a duration This method will take a string containing a formatted duration (e.g.

"1w2d") and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.

Definition at line 685 of file modules.cpp.

References duration().

00686 {
00687         return duration(delta.c_str());
00688 }

void Server::CallCommandHandler (  std::string  commandname,
char **  parameters,
int  pcnt,
userrec *  user
)  [virtual]
 

Calls the handler for a command, either implemented by the core or by another module.

You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or
) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.

Definition at line 396 of file modules.cpp.

References call_handler().

00397 {
00398         call_handler(commandname.c_str(),parameters,pcnt,user);
00399 }

void Server::ChangeGECOS (  userrec *  user,
std::string  gecos
)  [virtual]
 

Change GECOS (fullname) of a user.

You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.

Definition at line 494 of file modules.cpp.

References ChangeName().

00495 {
00496         ChangeName(user,gecos.c_str());
00497 }

void Server::ChangeHost (  userrec *  user,
std::string  host
)  [virtual]
 

Change displayed hostname of a user.

You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.

Definition at line 489 of file modules.cpp.

References ChangeDisplayedHost().

00490 {
00491         ChangeDisplayedHost(user,host.c_str());
00492 }

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 381 of file modules.cpp.

References force_nickchange().

00382 {
00383         force_nickchange(user,nickname.c_str());
00384 }

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 519 of file modules.cpp.

References cmode().

00520 {
00521         return cmode(User,Chan);
00522 }

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 467 of file modules.cpp.

References common_channels().

00468 {
00469         return (common_channels(u1,u2) != 0);
00470 }

int Server::CountUsers (  chanrec *  c  )  [virtual]
 

Returns a count of the number of users on a channel.

This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.

Definition at line 587 of file modules.cpp.

00588 {
00589         return usercount(c);
00590 }

bool Server::DelELine (  std::string  hostmask  )  [virtual]
 

Deletes a local E-Line.

Definition at line 680 of file modules.cpp.

References del_eline().

00681 {
00682         return del_eline(hostmask.c_str());
00683 }

bool Server::DelGLine (  std::string  hostmask  )  [virtual]
 

Deletes a G-Line from all servers on the mesh.

Definition at line 660 of file modules.cpp.

References del_gline().

00661 {
00662         return del_gline(hostmask.c_str());
00663 }

bool Server::DelKLine (  std::string  hostmask  )  [virtual]
 

Deletes a local K-Line.

Definition at line 675 of file modules.cpp.

References del_kline().

00676 {
00677         return del_kline(hostmask.c_str());
00678 }

bool Server::DelQLine (  std::string  nickname  )  [virtual]
 

Deletes a Q-Line from all servers on the mesh.

Definition at line 665 of file modules.cpp.

References del_qline().

00666 {
00667         return del_qline(nickname.c_str());
00668 }

void Server::DelSocket (  InspSocket *  sock  )  [virtual]
 

Deletes a class derived from InspSocket from the server's socket engine.

Definition at line 329 of file modules.cpp.

References module_sockets.

00330 {
00331         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
00332         {
00333                 if (*a == sock)
00334                 {
00335                         module_sockets.erase(a);
00336                         return;
00337                 }
00338         }
00339 }

bool Server::DelZLine (  std::string  ipaddr  )  [virtual]
 

Deletes a Z-Line from all servers on the mesh.

Definition at line 670 of file modules.cpp.

References del_zline().

00671 {
00672         return del_zline(ipaddr.c_str());
00673 }

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 514 of file modules.cpp.

References FindChan().

00515 {
00516         return FindChan(channel.c_str());
00517 }

userrec * Server::FindDescriptor (  int  socket  )  [virtual]
 

Attempts to look up a nick using the file descriptor associated with that nick.

This function will return NULL if the file descriptor is not associated with a valid user.

Definition at line 509 of file modules.cpp.

00510 {
00511         return (socket < 65536 ? fd_ref_table[socket] : NULL);
00512 }

Module * Server::FindModule (  std::string  name  )  [virtual]
 

This function finds a module by name.

You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.

Definition at line 719 of file modules.cpp.

References MODCOUNT, ServerConfig::module_names, and modules.

00720 {
00721         for (int i = 0; i <= MODCOUNT; i++)
00722         {
00723                 if (Config->module_names[i] == name)
00724                 {
00725                         return modules[i];
00726                 }
00727         }
00728         return NULL;
00729 }

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 504 of file modules.cpp.

References Find().

00505 {
00506         return Find(nick);
00507 }

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 544 of file modules.cpp.

References ServerConfig::AdminEmail, ServerConfig::AdminName, and ServerConfig::AdminNick.

00545 {
00546         return Admin(Config->AdminName,Config->AdminEmail,Config->AdminNick);
00547 }

ServerConfig * Server::GetConfig (   ) 
 

Obtains a pointer to the server's ServerConfig object.

The ServerConfig object contains most of the configuration data of the IRC server, as read from the config file by the core.

Definition at line 324 of file modules.cpp.

00325 {
00326         return Config;
00327 }

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

Returns the network name, global to all linked servers.

Definition at line 534 of file modules.cpp.

References ServerConfig::Network.

00535 {
00536         return Config->Network;
00537 }

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

Returns the server description string of the local server.

Definition at line 539 of file modules.cpp.

References ServerConfig::ServerDesc.

00540 {
00541         return Config->ServerDesc;
00542 }

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

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

Definition at line 529 of file modules.cpp.

References ServerConfig::ServerName.

00530 {
00531         return Config->ServerName;
00532 }

chanuserlist Server::GetUsers (  chanrec *  chan  )  [virtual]
 

Fetches the userlist of a channel.

This function must be here and not a member of userrec or chanrec due to include constraints.

Definition at line 369 of file modules.cpp.

References chanrec::GetUsers().

00370 {
00371         chanuserlist userl;
00372         userl.clear();
00373         std::vector<char*> *list = chan->GetUsers();
00374         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
00375         {
00376                 char* o = *i;
00377                 userl.push_back((userrec*)o);
00378         }
00379         return userl;
00380 }

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

Returns true if a nick is valid.

Nicks for unregistered connections will return false.

Definition at line 499 of file modules.cpp.

References isnick().

00500 {
00501         return (isnick(nick.c_str()) != 0);
00502 }

bool Server::IsOnChannel (  userrec *  User,
chanrec *  Chan
)  [virtual]
 

Checks if a user is on a channel.

This function will return true or false to indicate if user 'User' is on channel 'Chan'.

Definition at line 524 of file modules.cpp.

References has_channel().

00525 {
00526         return has_channel(User,Chan);
00527 }

bool Server::IsUlined (  std::string  server  )  [virtual]
 

Returns true if the servername you give is ulined.

ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.

Definition at line 391 of file modules.cpp.

References is_uline().

00392 {
00393         return is_uline(server.c_str());
00394 }

bool Server::IsValidMask (  std::string  mask  )  [virtual]
 

Returns true if a nick!ident string is correctly formatted, false if otherwise.

Definition at line 690 of file modules.cpp.

00691 {
00692         const char* dest = mask.c_str();
00693         if (strchr(dest,'!')==0)
00694                 return false;
00695         if (strchr(dest,'@')==0)
00696                 return false;
00697         for (unsigned int i = 0; i < strlen(dest); i++)
00698                 if (dest[i] < 32)
00699                         return false;
00700         for (unsigned int i = 0; i < strlen(dest); i++)
00701                 if (dest[i] > 126)
00702                         return false;
00703         unsigned int c = 0;
00704         for (unsigned int i = 0; i < strlen(dest); i++)
00705                 if (dest[i] == '!')
00706                         c++;
00707         if (c>1)
00708                 return false;
00709         c = 0;
00710         for (unsigned int i = 0; i < strlen(dest); i++)
00711                 if (dest[i] == '@')
00712                         c++;
00713         if (c>1)
00714                 return false;
00715 
00716         return true;
00717 }

bool Server::IsValidModuleCommand (  std::string  commandname,
int  pcnt,
userrec *  user
)  [virtual]
 

Definition at line 401 of file modules.cpp.

References is_valid_cmd().

00402 {
00403         return is_valid_cmd(commandname.c_str(), pcnt, user);
00404 }

chanrec * 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.

Definition at line 359 of file modules.cpp.

References add_channel().

00360 {
00361         return add_channel(user,cname.c_str(),key.c_str(),false);
00362 }

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 406 of file modules.cpp.

References log().

00407 {
00408         log(level,"%s",s.c_str());
00409 }

bool Server::MatchText (  std::string  sliteral,
std::string  spattern
)  [virtual]
 

Matches text against a glob pattern.

Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.

Definition at line 346 of file modules.cpp.

00347 {
00348         char literal[MAXBUF],pattern[MAXBUF];
00349         strlcpy(literal,sliteral.c_str(),MAXBUF);
00350         strlcpy(pattern,spattern.c_str(),MAXBUF);
00351         return match(literal,pattern);
00352 }

chanrec * 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.

Definition at line 364 of file modules.cpp.

References del_channel().

00365 {
00366         return del_channel(user,cname.c_str(),reason.c_str(),false);
00367 }

bool Server::PseudoToUser (  userrec *  alive,
userrec *  zombie,
std::string  message
)  [virtual]
 

This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.

The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.

Definition at line 605 of file modules.cpp.

References userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, kill_link(), chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, chanrec::topicset, Write(), WriteFrom(), and WriteServ().

00606 {
00607         zombie->fd = alive->fd;
00608         alive->fd = FD_MAGIC_NUMBER;
00609         alive->ClearBuffer();
00610         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
00611         kill_link(alive,message.c_str());
00612         fd_ref_table[zombie->fd] = zombie;
00613         for (unsigned int i = 0; i < zombie->chans.size(); i++)
00614         {
00615                 if (zombie->chans[i].channel != NULL)
00616                 {
00617                         if (zombie->chans[i].channel->name)
00618                         {
00619                                 chanrec* Ptr = zombie->chans[i].channel;
00620                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
00621                                 if (Ptr->topicset)
00622                                 {
00623                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
00624                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
00625                                 }
00626                                 userlist(zombie,Ptr);
00627                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
00628 
00629                         }
00630                 }
00631         }
00632         return true;
00633 }

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 386 of file modules.cpp.

References kill_link().

00387 {
00388         kill_link(user,reason.c_str());
00389 }

void Server::RehashServer (   )  [virtual]
 

Definition at line 318 of file modules.cpp.

References ServerConfig::Read(), and WriteOpers().

00319 {
00320         WriteOpers("*** Rehashing config file");
00321         Config->Read(false,NULL);
00322 }

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 421 of file modules.cpp.

References Write().

00422 {
00423         Write(Socket,"%s",s.c_str());
00424 }

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 455 of file modules.cpp.

References ChanExceptSender(), and WriteChannel().

00456 {
00457         if (IncludeSender)
00458         {
00459                 WriteChannel(Channel,User,"%s",s.c_str());
00460         }
00461         else
00462         {
00463                 ChanExceptSender(Channel,User,"%s",s.c_str());
00464         }
00465 }

void Server::SendChannelServerNotice (  std::string  ServName,
chanrec *  Channel,
std::string  text
)  [virtual]
 

Writes text to a channel, but from a server, including all.

This can be used to send server notices to a group of users.

Definition at line 450 of file modules.cpp.

00451 {
00452         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
00453 }

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 472 of file modules.cpp.

References WriteCommon(), and WriteCommonExcept().

00473 {
00474         if (IncludeSender)
00475         {
00476                 WriteCommon(User,"%s",text.c_str());
00477         }
00478         else
00479         {
00480                 WriteCommonExcept(User,"%s",text.c_str());
00481         }
00482 }

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 431 of file modules.cpp.

References WriteFrom().

00432 {
00433         WriteFrom(Socket,User,"%s",s.c_str());
00434 }

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 416 of file modules.cpp.

References server_mode().

00417 {
00418         server_mode(parameters,pcnt,user);
00419 }

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 341 of file modules.cpp.

References WriteOpers().

00342 {
00343         WriteOpers("%s",s.c_str());
00344 }

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 426 of file modules.cpp.

References WriteServ().

00427 {
00428         WriteServ(Socket,"%s",s.c_str());
00429 }

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) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:

:user!ident TEXT

The format will become:

:localserver TEXT

Which is useful for numerics and server notices to single users, etc.

Definition at line 436 of file modules.cpp.

References connection::fd, Write(), and WriteTo().

00437 {
00438         if (!Source)
00439         {
00440                 // if source is NULL, then the message originates from the local server
00441                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
00442         }
00443         else
00444         {
00445                 // otherwise it comes from the user specified
00446                 WriteTo(Source,Dest,"%s",s.c_str());
00447         }
00448 }

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 354 of file modules.cpp.

00355 {
00356         WriteMode(modes.c_str(),flags,"%s",text.c_str());
00357 }

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 484 of file modules.cpp.

References WriteWallOps().

00485 {
00486         WriteWallOps(User,false,"%s",text.c_str());
00487 }

bool Server::UserToPseudo (  userrec *  user,
std::string  message
)  [virtual]
 

Remove a user's connection to the irc server, but leave their client in existence in the user hash.

When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.

Definition at line 593 of file modules.cpp.

References userrec::ClearBuffer(), SocketEngine::DelFd(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, and Write().

00594 {
00595         unsigned int old_fd = user->fd;
00596         user->fd = FD_MAGIC_NUMBER;
00597         user->ClearBuffer();
00598         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
00599         SE->DelFd(old_fd);
00600         shutdown(old_fd,2);
00601         close(old_fd);
00602         return true;
00603 }

The documentation for this class was generated from the following files:
Generated on Wed Dec 14 19:16:27 2005 for InspIRCd by  doxygen 1.4.4-20050815