.TH "Server" 3 "25 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME Server \- 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. .PP .SH SYNOPSIS .br .PP \fC#include \fP .PP Inherits \fBclassbase\fP. .PP .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBServer\fP ()" .br .RI "\fIDefault constructor. \fP" .ti -1c .RI "virtual \fB~Server\fP ()" .br .RI "\fIDefault destructor. \fP" .ti -1c .RI "virtual void \fBSendOpers\fP (std::string s)" .br .RI "\fISends text to all opers. \fP" .ti -1c .RI "virtual void \fBLog\fP (int level, std::string s)" .br .RI "\fIWrites a log string. \fP" .ti -1c .RI "virtual void \fBSend\fP (int Socket, std::string s)" .br .RI "\fISends a line of text down a TCP/IP socket. \fP" .ti -1c .RI "virtual void \fBSendServ\fP (int Socket, std::string s)" .br .RI "\fISends text from the server to a socket. \fP" .ti -1c .RI "virtual void \fBSendChannelServerNotice\fP (std::string ServName, \fBchanrec\fP *Channel, std::string text)" .br .RI "\fIWrites text to a channel, but from a server, including all. \fP" .ti -1c .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)" .br .RI "\fISends text from a user to a socket. \fP" .ti -1c .RI "virtual void \fBSendTo\fP (\fBuserrec\fP *Source, \fBuserrec\fP *Dest, std::string s)" .br .RI "\fISends text from a user to another user. \fP" .ti -1c .RI "virtual void \fBSendChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Channel, std::string s, bool IncludeSender)" .br .RI "\fISends text from a user to a channel (mulicast). \fP" .ti -1c .RI "virtual bool \fBCommonChannels\fP (\fBuserrec\fP *u1, \fBuserrec\fP *u2)" .br .RI "\fIReturns true if two users share a common channel. \fP" .ti -1c .RI "virtual void \fBSendCommon\fP (\fBuserrec\fP *User, std::string text, bool IncludeSender)" .br .RI "\fISends text from a user to one or more channels (mulicast). \fP" .ti -1c .RI "virtual void \fBSendWallops\fP (\fBuserrec\fP *User, std::string text)" .br .RI "\fISends a WALLOPS message. \fP" .ti -1c .RI "virtual bool \fBIsNick\fP (std::string nick)" .br .RI "\fIReturns true if a nick is valid. \fP" .ti -1c .RI "virtual int \fBCountUsers\fP (\fBchanrec\fP *c)" .br .RI "\fIReturns a count of the number of users on a channel. \fP" .ti -1c .RI "virtual \fBuserrec\fP * \fBFindNick\fP (std::string nick)" .br .RI "\fIAttempts to look up a nick and return a pointer to it. \fP" .ti -1c .RI "virtual \fBuserrec\fP * \fBFindDescriptor\fP (int socket)" .br .RI "\fIAttempts to look up a nick using the file descriptor associated with that nick. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)" .br .RI "\fIAttempts to look up a channel and return a pointer to it. \fP" .ti -1c .RI "virtual std::string \fBChanMode\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)" .br .RI "\fIAttempts to look up a user's privilages on a channel. \fP" .ti -1c .RI "virtual bool \fBIsOnChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)" .br .RI "\fIChecks if a user is on a channel. \fP" .ti -1c .RI "virtual std::string \fBGetServerName\fP ()" .br .RI "\fIReturns the server name of the server where the module is loaded. \fP" .ti -1c .RI "virtual std::string \fBGetNetworkName\fP ()" .br .RI "\fIReturns the network name, global to all linked servers. \fP" .ti -1c .RI "virtual std::string \fBGetServerDescription\fP ()" .br .RI "\fIReturns the server description string of the local server. \fP" .ti -1c .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()" .br .RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP" .ti -1c .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)" .br .RI "\fIAdds an extended mode letter which is parsed by a module. \fP" .ti -1c .RI "virtual bool \fBAddExtendedListMode\fP (char modechar)" .br .RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP" .ti -1c .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)" .br .RI "\fIAdds a command to the command table. \fP" .ti -1c .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .RI "\fISends a servermode. \fP" .ti -1c .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)" .br .RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)" .br .RI "\fIForces a user to join a channel. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)" .br .RI "\fIForces a user to part a channel. \fP" .ti -1c .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)" .br .RI "\fIForces a user nickchange. \fP" .ti -1c .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)" .br .RI "\fIForces a user to quit with the specified reason. \fP" .ti -1c .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)" .br .RI "\fIMatches text against a glob pattern. \fP" .ti -1c .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)" .br .RI "\fICalls the handler for a command, either implemented by the core or by another module. \fP" .ti -1c .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)" .br .RI "\fIChange displayed hostname of a user. \fP" .ti -1c .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)" .br .RI "\fIChange GECOS (fullname) of a user. \fP" .ti -1c .RI "virtual bool \fBIsUlined\fP (std::string server)" .br .RI "\fIReturns true if the servername you give is ulined. \fP" .ti -1c .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)" .br .RI "\fIFetches the userlist of a channel. \fP" .ti -1c .RI "virtual bool \fBUserToPseudo\fP (\fBuserrec\fP *user, std::string message)" .br .RI "\fIRemove a user's connection to the irc server, but leave their client in existence in the user hash. \fP" .ti -1c .RI "virtual bool \fBPseudoToUser\fP (\fBuserrec\fP *alive, \fBuserrec\fP *zombie, std::string message)" .br .RI "\fIThis user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. \fP" .ti -1c .RI "virtual void \fBAddGLine\fP (long duration, std::string source, std::string reason, std::string hostmask)" .br .RI "\fIAdds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" .ti -1c .RI "virtual void \fBAddQLine\fP (long duration, std::string source, std::string reason, std::string nickname)" .br .RI "\fIAdds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" .ti -1c .RI "virtual void \fBAddZLine\fP (long duration, std::string source, std::string reason, std::string ipaddr)" .br .RI "\fIAdds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" .ti -1c .RI "virtual void \fBAddKLine\fP (long duration, std::string source, std::string reason, std::string hostmask)" .br .RI "\fIAdds a K-line The K-line is enforced as soon as it is added. \fP" .ti -1c .RI "virtual void \fBAddELine\fP (long duration, std::string source, std::string reason, std::string hostmask)" .br .RI "\fIAdds a E-line The E-line is enforced as soon as it is added. \fP" .ti -1c .RI "virtual bool \fBDelGLine\fP (std::string hostmask)" .br .RI "\fIDeletes a G-Line from all servers on the mesh. \fP" .ti -1c .RI "virtual bool \fBDelQLine\fP (std::string nickname)" .br .RI "\fIDeletes a Q-Line from all servers on the mesh. \fP" .ti -1c .RI "virtual bool \fBDelZLine\fP (std::string ipaddr)" .br .RI "\fIDeletes a Z-Line from all servers on the mesh. \fP" .ti -1c .RI "virtual bool \fBDelKLine\fP (std::string hostmask)" .br .RI "\fIDeletes a local K-Line. \fP" .ti -1c .RI "virtual bool \fBDelELine\fP (std::string hostmask)" .br .RI "\fIDeletes a local E-Line. \fP" .ti -1c .RI "virtual long \fBCalcDuration\fP (std::string duration)" .br .RI "\fICalculates a duration This method will take a string containing a formatted duration (e.g. \fP" .ti -1c .RI "virtual bool \fBIsValidMask\fP (std::string mask)" .br .RI "\fIReturns true if a nick!ident string is correctly formatted, false if otherwise. \fP" .ti -1c .RI "virtual void \fBMeshSendAll\fP (std::string text)" .br .RI "\fISends a line of text to all connected servers. \fP" .ti -1c .RI "virtual void \fBMeshSendCommon\fP (\fBuserrec\fP *user, std::string text)" .br .RI "\fIThis method sends a line of text to all servers who have users which share common channels with the user you provide. \fP" .ti -1c .RI "virtual void \fBMeshSendAllAlive\fP (std::string text)" .br .RI "\fIThis function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. \fP" .ti -1c .RI "virtual void \fBMeshSendUnicast\fP (std::string destination, std::string text)" .br .RI "\fIThis function sends a line of text directly to a server. \fP" .ti -1c .RI "virtual void \fBMeshSendAllExcept\fP (std::string target, std::string text)" .br .RI "\fIThis function sends to all servers EXCEPT the one you specify. \fP" .ti -1c .RI "virtual bool \fBMeshCheckChan\fP (\fBchanrec\fP *c, std::string servername)" .br .RI "\fIThis function is used to check if any users on channel c are on server servername. \fP" .ti -1c .RI "virtual bool \fBMeshCheckCommon\fP (\fBuserrec\fP *u, std::string servername)" .br .RI "\fIThis function is used to check if user u has any channels in common with users on servername. \fP" .ti -1c .RI "virtual \fBModule\fP * \fBFindModule\fP (std::string name)" .br .RI "\fIThis function finds a module by name. \fP" .in -1c .SH "Detailed Description" .PP 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. .PP Definition at line 694 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP Default constructor. Creates a Server object.Definition at line 364 of file modules.cpp. .PP .nf 365 { 366 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP Default destructor. Destroys a Server object.Definition at line 368 of file modules.cpp. .PP .nf 369 { 370 } .fi .SH "Member Function Documentation" .PP .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP" .PP 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: .PP typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP .PP 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 437 of file modules.cpp. .PP References createcommand(). .PP .nf 438 { 439 createcommand(cmd,f,flags,minparams,source); 440 } .fi .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP 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 \fBServer::CalcDuration\fP 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 699 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf 700 { 701 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); 702 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP 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: .PP (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL .PP (2) They always take exactly one parameter when being added or removed .PP (3) They can be set multiple times, usually on users in channels .PP (4) The mode and its parameter are NOT stored in the channels modes structure .PP 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 605 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf 606 { 607 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); 608 if (res) 609 ModeMakeList(modechar); 610 return res; 611 } .fi .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP" .PP 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 577 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf 578 { 579 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) 580 { 581 if (type == MT_SERVER) 582 { 583 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); 584 return false; 585 } 586 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) 587 { 588 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); 589 return false; 590 } 591 if ((params_when_on>1) || (params_when_off>1)) 592 { 593 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); 594 return false; 595 } 596 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); 597 } 598 else 599 { 600 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); 601 } 602 return false; 603 } .fi .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP 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 \fBServer::CalcDuration\fP 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 679 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf 680 { 681 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); 682 } .fi .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP 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 \fBServer::CalcDuration\fP 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 694 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf 695 { 696 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); 697 } .fi .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP" .PP 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 \fBServer::CalcDuration\fP 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 684 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf 685 { 686 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); 687 } .fi .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP" .PP 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 \fBServer::CalcDuration\fP 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 689 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf 690 { 691 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); 692 } .fi .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP" .PP 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 729 of file modules.cpp. .PP References duration(). .PP .nf 730 { 731 return duration(delta.c_str()); 732 } .fi .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP 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 .br ) 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 \fBAddCommand()\fP. 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 427 of file modules.cpp. .PP .nf 428 { 429 call_handler(commandname.c_str(),parameters,pcnt,user); 430 } .fi .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP" .PP 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 520 of file modules.cpp. .PP References ChangeName(). .PP .nf 521 { 522 ChangeName(user,gecos.c_str()); 523 } .fi .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP" .PP 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 515 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf 516 { 517 ChangeDisplayedHost(user,host.c_str()); 518 } .fi .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP" .PP 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 412 of file modules.cpp. .PP .nf 413 { 414 force_nickchange(user,nickname.c_str()); 415 } .fi .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP 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 545 of file modules.cpp. .PP References cmode(). .PP .nf 546 { 547 return cmode(User,Chan); 548 } .fi .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP" .PP Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 493 of file modules.cpp. .PP References common_channels(). .PP .nf 494 { 495 return (common_channels(u1,u2) != 0); 496 } .fi .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP" .PP 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 613 of file modules.cpp. .PP .nf 614 { 615 return usercount(c); 616 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP Deletes a local E-Line. Definition at line 724 of file modules.cpp. .PP References del_eline(). .PP .nf 725 { 726 del_eline(hostmask.c_str()); 727 } .fi .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP" .PP Deletes a G-Line from all servers on the mesh. Definition at line 704 of file modules.cpp. .PP References del_gline(). .PP .nf 705 { 706 del_gline(hostmask.c_str()); 707 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP Deletes a local K-Line. Definition at line 719 of file modules.cpp. .PP References del_kline(). .PP .nf 720 { 721 del_kline(hostmask.c_str()); 722 } .fi .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP" .PP Deletes a Q-Line from all servers on the mesh. Definition at line 709 of file modules.cpp. .PP References del_qline(). .PP .nf 710 { 711 del_qline(nickname.c_str()); 712 } .fi .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP" .PP Deletes a Z-Line from all servers on the mesh. Definition at line 714 of file modules.cpp. .PP References del_zline(). .PP .nf 715 { 716 del_zline(ipaddr.c_str()); 717 } .fi .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP" .PP 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 540 of file modules.cpp. .PP .nf 541 { 542 return FindChan(channel.c_str()); 543 } .fi .SS "\fBuserrec\fP * Server::FindDescriptor (int socket)\fC [virtual]\fP" .PP 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 535 of file modules.cpp. .PP References fd_ref_table. .PP .nf 536 { 537 return (socket < 65536 ? fd_ref_table[socket] : NULL); 538 } .fi .SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP" .PP 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 807 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf 808 { 809 for (int i = 0; i <= MODCOUNT; i++) 810 { 811 if (module_names[i] == name) 812 { 813 return modules[i]; 814 } 815 } 816 return NULL; 817 } .fi .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP" .PP 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 530 of file modules.cpp. .PP .nf 531 { 532 return Find(nick); 533 } .fi .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP" .PP Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 570 of file modules.cpp. .PP .nf 571 { 572 return Admin(getadminname(),getadminemail(),getadminnick()); 573 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP Returns the network name, global to all linked servers. Definition at line 560 of file modules.cpp. .PP .nf 561 { 562 return getnetworkname(); 563 } .fi .SS "std::string Server::GetServerDescription ()\fC [virtual]\fP" .PP Returns the server description string of the local server. Definition at line 565 of file modules.cpp. .PP .nf 566 { 567 return getserverdesc(); 568 } .fi .SS "std::string Server::GetServerName ()\fC [virtual]\fP" .PP Returns the server name of the server where the module is loaded. Definition at line 555 of file modules.cpp. .PP .nf 556 { 557 return getservername(); 558 } .fi .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP 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 400 of file modules.cpp. .PP References chanuserlist, chanrec::GetUsers(), and list. .PP .nf 401 { 402 chanuserlist userl; 403 userl.clear(); 404 std::vector *list = chan->GetUsers(); 405 for (std::vector::iterator i = list->begin(); i != list->end(); i++) 406 { 407 char* o = *i; 408 userl.push_back((userrec*)o); 409 } 410 return userl; 411 } .fi .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP" .PP Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 525 of file modules.cpp. .PP References isnick(). .PP .nf 526 { 527 return (isnick(nick.c_str()) != 0); 528 } .fi .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP 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 550 of file modules.cpp. .PP References has_channel(). .PP .nf 551 { 552 return has_channel(User,Chan); 553 } .fi .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP" .PP 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 422 of file modules.cpp. .PP References is_uline(). .PP .nf 423 { 424 return is_uline(server.c_str()); 425 } .fi .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP" .PP Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 734 of file modules.cpp. .PP .nf 735 { 736 const char* dest = mask.c_str(); 737 if (strchr(dest,'!')==0) 738 return false; 739 if (strchr(dest,'@')==0) 740 return false; 741 for (int i = 0; i < strlen(dest); i++) 742 if (dest[i] < 32) 743 return false; 744 for (int i = 0; i < strlen(dest); i++) 745 if (dest[i] > 126) 746 return false; 747 int c = 0; 748 for (int i = 0; i < strlen(dest); i++) 749 if (dest[i] == '!') 750 c++; 751 if (c>1) 752 return false; 753 c = 0; 754 for (int i = 0; i < strlen(dest); i++) 755 if (dest[i] == '@') 756 c++; 757 if (c>1) 758 return false; 759 760 return true; 761 } .fi .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP" .PP 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 390 of file modules.cpp. .PP .nf 391 { 392 return add_channel(user,cname.c_str(),key.c_str(),false); 393 } .fi .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP" .PP 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 432 of file modules.cpp. .PP .nf 433 { 434 log(level,'%s',s.c_str()); 435 } .fi .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP" .PP 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 377 of file modules.cpp. .PP .nf 378 { 379 char literal[MAXBUF],pattern[MAXBUF]; 380 strlcpy(literal,sliteral.c_str(),MAXBUF); 381 strlcpy(pattern,spattern.c_str(),MAXBUF); 382 return match(literal,pattern); 383 } .fi .SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP" .PP This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 789 of file modules.cpp. .PP .nf 790 { 791 if (c) 792 { 793 return ChanAnyOnThisServer(c,(char*)servername.c_str()); 794 } 795 else return false; 796 } .fi .SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP" .PP This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 798 of file modules.cpp. .PP .nf 799 { 800 if (u) 801 { 802 return CommonOnThisServer(u,(char*)servername.c_str()); 803 } 804 else return false; 805 } .fi .SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP" .PP Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 763 of file modules.cpp. .PP .nf 764 { 765 NetSendToAll((char*)text.c_str()); 766 } .fi .SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP" .PP This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 774 of file modules.cpp. .PP .nf 775 { 776 NetSendToAllAlive((char*)text.c_str()); 777 } .fi .SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP" .PP This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 784 of file modules.cpp. .PP .nf 785 { 786 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); 787 } .fi .SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP" .PP This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 768 of file modules.cpp. .PP .nf 769 { 770 if (user) 771 NetSendToCommon(user,(char*)text.c_str()); 772 } .fi .SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP" .PP This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 779 of file modules.cpp. .PP .nf 780 { 781 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); 782 } .fi .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP" .PP 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 395 of file modules.cpp. .PP .nf 396 { 397 return del_channel(user,cname.c_str(),reason.c_str(),false); 398 } .fi .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP" .PP 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 649 of file modules.cpp. .PP References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. .PP .nf 650 { 651 zombie->fd = alive->fd; 652 alive->fd = FD_MAGIC_NUMBER; 653 alive->ClearBuffer(); 654 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); 655 kill_link(alive,message.c_str()); 656 fd_ref_table[zombie->fd] = zombie; 657 for (int i = 0; i != MAXCHANS; i++) 658 { 659 if (zombie->chans[i].channel != NULL) 660 { 661 if (zombie->chans[i].channel->name) 662 { 663 chanrec* Ptr = zombie->chans[i].channel; 664 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); 665 if (Ptr->topicset) 666 { 667 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); 668 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); 669 } 670 userlist(zombie,Ptr); 671 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); 672 673 } 674 } 675 } 676 677 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP 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. .PP WARNING! .PP 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 417 of file modules.cpp. .PP .nf 418 { 419 kill_link(user,reason.c_str()); 420 } .fi .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP" .PP 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 447 of file modules.cpp. .PP .nf 448 { 449 Write(Socket,'%s',s.c_str()); 450 } .fi .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP" .PP 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 481 of file modules.cpp. .PP .nf 482 { 483 if (IncludeSender) 484 { 485 WriteChannel(Channel,User,'%s',s.c_str()); 486 } 487 else 488 { 489 ChanExceptSender(Channel,User,'%s',s.c_str()); 490 } 491 } .fi .SS "void Server::SendChannelServerNotice (std::string ServName, \fBchanrec\fP * Channel, std::string text)\fC [virtual]\fP" .PP 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 476 of file modules.cpp. .PP .nf 477 { 478 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); 479 } .fi .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP" .PP 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 498 of file modules.cpp. .PP .nf 499 { 500 if (IncludeSender) 501 { 502 WriteCommon(User,'%s',text.c_str()); 503 } 504 else 505 { 506 WriteCommonExcept(User,'%s',text.c_str()); 507 } 508 } .fi .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP" .PP 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 457 of file modules.cpp. .PP .nf 458 { 459 WriteFrom(Socket,User,'%s',s.c_str()); 460 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes. .PP For example: .PP char *modes[3]; .PP modes[0] = ChannelName; .PP modes[1] = '+o'; .PP modes[2] = user->nick; .PP Srv->SendMode(modes,3,user); .PP 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 442 of file modules.cpp. .PP References server_mode(). .PP .nf 443 { 444 server_mode(parameters,pcnt,user); 445 } .fi .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP" .PP Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 372 of file modules.cpp. .PP .nf 373 { 374 WriteOpers('%s',s.c_str()); 375 } .fi .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP" .PP 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 452 of file modules.cpp. .PP .nf 453 { 454 WriteServ(Socket,'%s',s.c_str()); 455 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP 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: .PP :user!ident TEXT .PP The format will become: .PP :localserver TEXT .PP Which is useful for numerics and server notices to single users, etc.Definition at line 462 of file modules.cpp. .PP References connection::fd. .PP .nf 463 { 464 if (!Source) 465 { 466 // if source is NULL, then the message originates from the local server 467 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); 468 } 469 else 470 { 471 // otherwise it comes from the user specified 472 WriteTo(Source,Dest,'%s',s.c_str()); 473 } 474 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP 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: .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP 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 385 of file modules.cpp. .PP .nf 386 { 387 WriteMode(modes.c_str(),flags,'%s',text.c_str()); 388 } .fi .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP" .PP 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 510 of file modules.cpp. .PP .nf 511 { 512 WriteWallOps(User,false,'%s',text.c_str()); 513 } .fi .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP" .PP 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 619 of file modules.cpp. .PP References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf 620 { 621 unsigned int old_fd = user->fd; 622 user->fd = FD_MAGIC_NUMBER; 623 user->ClearBuffer(); 624 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); 625 #ifdef USE_KQUEUE 626 struct kevent ke; 627 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); 628 int i = kevent(kq, &ke, 1, 0, 0, NULL); 629 if (i == -1) 630 { 631 log(DEBUG,'kqueue: Failed to remove user from queue!'); 632 } 633 #endif 634 #ifdef USE_EPOLL 635 struct epoll_event ev; 636 ev.events = EPOLLIN | EPOLLET; 637 ev.data.fd = old_fd; 638 int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev); 639 if (i < 0) 640 { 641 log(DEBUG,'epoll: List deletion failure!'); 642 } 643 #endif 644 645 shutdown(old_fd,2); 646 close(old_fd); 647 } .fi .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code.