diff options
Diffstat (limited to 'docs/man/man3/Server.3')
| -rw-r--r-- | docs/man/man3/Server.3 | 769 |
1 files changed, 391 insertions, 378 deletions
diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index d9c89aa98..93daa2cc9 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -104,6 +104,10 @@ Inherits \fBclassbase\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" @@ -267,19 +271,19 @@ Definition at line 694 of file modules.h. .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 431 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 355 of file modules.cpp. .PP .nf -432 { -433 } +356 { +357 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 435 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 359 of file modules.cpp. .PP .nf -436 { -437 } +360 { +361 } .fi .SH "Member Function Documentation" .PP @@ -289,25 +293,25 @@ Adds a command to the command table. This allows modules to add extra commands i .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 504 of file modules.cpp. +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 428 of file modules.cpp. .PP References createcommand(). .PP .nf -505 { -506 createcommand(cmd,f,flags,minparams,source); -507 } +429 { +430 createcommand(cmd,f,flags,minparams,source); +431 } .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 750 of file modules.cpp. +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 679 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -751 { -752 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -753 } +680 { +681 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +682 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -321,540 +325,549 @@ Adds an extended mode letter which is parsed by a module and handled in a list f .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 667 of file modules.cpp. +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 596 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -668 { -669 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -670 if (res) -671 ModeMakeList(modechar); -672 return res; -673 } +597 { +598 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +599 if (res) +600 ModeMakeList(modechar); +601 return res; +602 } .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 639 of file modules.cpp. +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 568 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -640 { -641 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) -642 { -643 if (type == MT_SERVER) -644 { -645 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -646 return false; -647 } -648 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -649 { -650 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -651 return false; -652 } -653 if ((params_when_on>1) || (params_when_off>1)) -654 { -655 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -656 return false; -657 } -658 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -659 } -660 else -661 { -662 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); -663 } -664 return false; -665 } +569 { +570 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +571 { +572 if (type == MT_SERVER) +573 { +574 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +575 return false; +576 } +577 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +578 { +579 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +580 return false; +581 } +582 if ((params_when_on>1) || (params_when_off>1)) +583 { +584 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +585 return false; +586 } +587 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +588 } +589 else +590 { +591 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +592 } +593 return false; +594 } .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 730 of file modules.cpp. +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 659 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -731 { -732 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -733 } +660 { +661 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +662 } .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 745 of file modules.cpp. +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 674 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -746 { -747 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -748 } +675 { +676 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +677 } .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 735 of file modules.cpp. +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 664 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -736 { -737 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -738 } +665 { +666 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +667 } .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 740 of file modules.cpp. +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 669 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -741 { -742 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -743 } +670 { +671 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +672 } .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 780 of file modules.cpp. +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 709 of file modules.cpp. .PP References duration(). .PP .nf -781 { -782 return duration(delta.c_str()); -783 } +710 { +711 return duration(delta.c_str()); +712 } .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 494 of file modules.cpp. +) 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 418 of file modules.cpp. .PP .nf -495 { -496 call_handler(commandname.c_str(),parameters,pcnt,user); -497 } +419 { +420 call_handler(commandname.c_str(),parameters,pcnt,user); +421 } .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 587 of file modules.cpp. +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 511 of file modules.cpp. .PP References ChangeName(). .PP .nf -588 { -589 ChangeName(user,gecos.c_str()); -590 } +512 { +513 ChangeName(user,gecos.c_str()); +514 } .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 582 of file modules.cpp. +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 506 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -583 { -584 ChangeDisplayedHost(user,host.c_str()); -585 } +507 { +508 ChangeDisplayedHost(user,host.c_str()); +509 } .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 479 of file modules.cpp. +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 403 of file modules.cpp. .PP .nf -480 { -481 force_nickchange(user,nickname.c_str()); -482 } +404 { +405 force_nickchange(user,nickname.c_str()); +406 } .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 612 of file modules.cpp. +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 536 of file modules.cpp. .PP References cmode(). .PP .nf -613 { -614 return cmode(User,Chan); -615 } +537 { +538 return cmode(User,Chan); +539 } .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 560 of file modules.cpp. +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 484 of file modules.cpp. .PP References common_channels(). .PP .nf -561 { -562 return (common_channels(u1,u2) != 0); -563 } +485 { +486 return (common_channels(u1,u2) != 0); +487 } .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 675 of file modules.cpp. +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 604 of file modules.cpp. .PP .nf -676 { -677 return usercount(c); -678 } +605 { +606 return usercount(c); +607 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 775 of file modules.cpp. +Deletes a local E-Line. Definition at line 704 of file modules.cpp. .PP References del_eline(). .PP .nf -776 { -777 del_eline(hostmask.c_str()); -778 } +705 { +706 del_eline(hostmask.c_str()); +707 } .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 755 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 684 of file modules.cpp. .PP References del_gline(). .PP .nf -756 { -757 del_gline(hostmask.c_str()); -758 } +685 { +686 del_gline(hostmask.c_str()); +687 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 770 of file modules.cpp. +Deletes a local K-Line. Definition at line 699 of file modules.cpp. .PP References del_kline(). .PP .nf -771 { -772 del_kline(hostmask.c_str()); -773 } +700 { +701 del_kline(hostmask.c_str()); +702 } .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 760 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 689 of file modules.cpp. .PP References del_qline(). .PP .nf -761 { -762 del_qline(nickname.c_str()); -763 } +690 { +691 del_qline(nickname.c_str()); +692 } .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 765 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 694 of file modules.cpp. .PP References del_zline(). .PP .nf -766 { -767 del_zline(ipaddr.c_str()); -768 } +695 { +696 del_zline(ipaddr.c_str()); +697 } .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 607 of file modules.cpp. +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 531 of file modules.cpp. .PP .nf -608 { -609 return FindChan(channel.c_str()); -610 } +532 { +533 return FindChan(channel.c_str()); +534 } .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 602 of file modules.cpp. +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 526 of file modules.cpp. .PP References fd_ref_table. .PP .nf -603 { -604 return (socket < 65536 ? fd_ref_table[socket] : NULL); -605 } +527 { +528 return (socket < 65536 ? fd_ref_table[socket] : NULL); +529 } .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 858 of file modules.cpp. +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 787 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -859 { -860 for (int i = 0; i <= MODCOUNT; i++) -861 { -862 if (module_names[i] == name) -863 { -864 return modules[i]; -865 } -866 } -867 return NULL; -868 } +788 { +789 for (int i = 0; i <= MODCOUNT; i++) +790 { +791 if (module_names[i] == name) +792 { +793 return modules[i]; +794 } +795 } +796 return NULL; +797 } .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 597 of file modules.cpp. +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 521 of file modules.cpp. .PP .nf -598 { -599 return Find(nick); -600 } +522 { +523 return Find(nick); +524 } .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 632 of file modules.cpp. +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 561 of file modules.cpp. .PP .nf -633 { -634 return Admin(getadminname(),getadminemail(),getadminnick()); -635 } +562 { +563 return Admin(getadminname(),getadminemail(),getadminnick()); +564 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 627 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 551 of file modules.cpp. +.PP +.nf +552 { +553 return getnetworkname(); +554 } +.fi +.SS "std::string Server::GetServerDescription ()\fC [virtual]\fP" +.PP +Returns the server description string of the local server. Definition at line 556 of file modules.cpp. .PP .nf -628 { -629 return getnetworkname(); -630 } +557 { +558 return getserverdesc(); +559 } .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 622 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 546 of file modules.cpp. .PP .nf -623 { -624 return getservername(); -625 } +547 { +548 return getservername(); +549 } .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 467 of file modules.cpp. +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 391 of file modules.cpp. .PP References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -468 { -469 chanuserlist userl; -470 userl.clear(); -471 std::vector<char*> *list = chan->GetUsers(); -472 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) -473 { -474 char* o = *i; -475 userl.push_back((userrec*)o); -476 } -477 return userl; -478 } +392 { +393 chanuserlist userl; +394 userl.clear(); +395 std::vector<char*> *list = chan->GetUsers(); +396 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +397 { +398 char* o = *i; +399 userl.push_back((userrec*)o); +400 } +401 return userl; +402 } .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 592 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 516 of file modules.cpp. .PP References isnick(). .PP .nf -593 { -594 return (isnick(nick.c_str()) != 0); -595 } +517 { +518 return (isnick(nick.c_str()) != 0); +519 } .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 617 of file modules.cpp. +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 541 of file modules.cpp. .PP References has_channel(). .PP .nf -618 { -619 return has_channel(User,Chan); -620 } +542 { +543 return has_channel(User,Chan); +544 } .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 489 of file modules.cpp. +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 413 of file modules.cpp. .PP References is_uline(). .PP .nf -490 { -491 return is_uline(server.c_str()); -492 } +414 { +415 return is_uline(server.c_str()); +416 } .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 785 of file modules.cpp. +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 714 of file modules.cpp. .PP .nf -786 { -787 const char* dest = mask.c_str(); -788 if (strchr(dest,'!')==0) -789 return false; -790 if (strchr(dest,'@')==0) -791 return false; -792 for (int i = 0; i < strlen(dest); i++) -793 if (dest[i] < 32) -794 return false; -795 for (int i = 0; i < strlen(dest); i++) -796 if (dest[i] > 126) -797 return false; -798 int c = 0; -799 for (int i = 0; i < strlen(dest); i++) -800 if (dest[i] == '!') -801 c++; -802 if (c>1) -803 return false; -804 c = 0; -805 for (int i = 0; i < strlen(dest); i++) -806 if (dest[i] == '@') -807 c++; -808 if (c>1) -809 return false; -810 -811 return true; -812 } +715 { +716 const char* dest = mask.c_str(); +717 if (strchr(dest,'!')==0) +718 return false; +719 if (strchr(dest,'@')==0) +720 return false; +721 for (int i = 0; i < strlen(dest); i++) +722 if (dest[i] < 32) +723 return false; +724 for (int i = 0; i < strlen(dest); i++) +725 if (dest[i] > 126) +726 return false; +727 int c = 0; +728 for (int i = 0; i < strlen(dest); i++) +729 if (dest[i] == '!') +730 c++; +731 if (c>1) +732 return false; +733 c = 0; +734 for (int i = 0; i < strlen(dest); i++) +735 if (dest[i] == '@') +736 c++; +737 if (c>1) +738 return false; +739 +740 return true; +741 } .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 457 of file modules.cpp. +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 381 of file modules.cpp. .PP .nf -458 { -459 return add_channel(user,cname.c_str(),key.c_str(),false); -460 } +382 { +383 return add_channel(user,cname.c_str(),key.c_str(),false); +384 } .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 499 of file modules.cpp. +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 423 of file modules.cpp. .PP .nf -500 { -501 log(level,'%s',s.c_str()); -502 } +424 { +425 log(level,'%s',s.c_str()); +426 } .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 444 of file modules.cpp. +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 368 of file modules.cpp. .PP .nf -445 { -446 char literal[MAXBUF],pattern[MAXBUF]; -447 strlcpy(literal,sliteral.c_str(),MAXBUF); -448 strlcpy(pattern,spattern.c_str(),MAXBUF); -449 return match(literal,pattern); -450 } +369 { +370 char literal[MAXBUF],pattern[MAXBUF]; +371 strlcpy(literal,sliteral.c_str(),MAXBUF); +372 strlcpy(pattern,spattern.c_str(),MAXBUF); +373 return match(literal,pattern); +374 } .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 840 of file modules.cpp. +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 769 of file modules.cpp. .PP .nf -841 { -842 if (c) -843 { -844 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -845 } -846 else return false; -847 } +770 { +771 if (c) +772 { +773 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +774 } +775 else return false; +776 } .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 849 of file modules.cpp. +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 778 of file modules.cpp. .PP .nf -850 { -851 if (u) -852 { -853 return CommonOnThisServer(u,(char*)servername.c_str()); -854 } -855 else return false; -856 } +779 { +780 if (u) +781 { +782 return CommonOnThisServer(u,(char*)servername.c_str()); +783 } +784 else return false; +785 } .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 814 of file modules.cpp. +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 743 of file modules.cpp. .PP .nf -815 { -816 NetSendToAll((char*)text.c_str()); -817 } +744 { +745 NetSendToAll((char*)text.c_str()); +746 } .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 825 of file modules.cpp. +This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 754 of file modules.cpp. .PP .nf -826 { -827 NetSendToAllAlive((char*)text.c_str()); -828 } +755 { +756 NetSendToAllAlive((char*)text.c_str()); +757 } .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 835 of file modules.cpp. +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 764 of file modules.cpp. .PP .nf -836 { -837 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -838 } +765 { +766 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +767 } .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 819 of file modules.cpp. +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 748 of file modules.cpp. .PP .nf -820 { -821 if (user) -822 NetSendToCommon(user,(char*)text.c_str()); -823 } +749 { +750 if (user) +751 NetSendToCommon(user,(char*)text.c_str()); +752 } .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 830 of file modules.cpp. +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 759 of file modules.cpp. .PP .nf -831 { -832 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -833 } +760 { +761 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +762 } .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 462 of file modules.cpp. +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 386 of file modules.cpp. .PP .nf -463 { -464 return del_channel(user,cname.c_str(),reason.c_str(),false); -465 } +387 { +388 return del_channel(user,cname.c_str(),reason.c_str(),false); +389 } .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 700 of file modules.cpp. +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 629 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 -701 { -702 zombie->fd = alive->fd; -703 alive->fd = FD_MAGIC_NUMBER; -704 alive->ClearBuffer(); -705 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); -706 kill_link(alive,message.c_str()); -707 fd_ref_table[zombie->fd] = zombie; -708 for (int i = 0; i != MAXCHANS; i++) -709 { -710 if (zombie->chans[i].channel != NULL) -711 { -712 if (zombie->chans[i].channel->name) -713 { -714 chanrec* Ptr = zombie->chans[i].channel; -715 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); -716 if (Ptr->topicset) -717 { -718 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); -719 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -720 } -721 userlist(zombie,Ptr); -722 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); -723 -724 } -725 } -726 } -727 -728 } +630 { +631 zombie->fd = alive->fd; +632 alive->fd = FD_MAGIC_NUMBER; +633 alive->ClearBuffer(); +634 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +635 kill_link(alive,message.c_str()); +636 fd_ref_table[zombie->fd] = zombie; +637 for (int i = 0; i != MAXCHANS; i++) +638 { +639 if (zombie->chans[i].channel != NULL) +640 { +641 if (zombie->chans[i].channel->name) +642 { +643 chanrec* Ptr = zombie->chans[i].channel; +644 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +645 if (Ptr->topicset) +646 { +647 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +648 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +649 } +650 userlist(zombie,Ptr); +651 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +652 +653 } +654 } +655 } +656 +657 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -862,71 +875,71 @@ Forces a user to quit with the specified reason. To the user, it will appear as .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 484 of file modules.cpp. +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 408 of file modules.cpp. .PP .nf -485 { -486 kill_link(user,reason.c_str()); -487 } +409 { +410 kill_link(user,reason.c_str()); +411 } .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 514 of file modules.cpp. +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 438 of file modules.cpp. .PP .nf -515 { -516 Write(Socket,'%s',s.c_str()); -517 } +439 { +440 Write(Socket,'%s',s.c_str()); +441 } .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 548 of file modules.cpp. +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 472 of file modules.cpp. .PP .nf -549 { -550 if (IncludeSender) -551 { -552 WriteChannel(Channel,User,'%s',s.c_str()); -553 } -554 else -555 { -556 ChanExceptSender(Channel,User,'%s',s.c_str()); -557 } -558 } +473 { +474 if (IncludeSender) +475 { +476 WriteChannel(Channel,User,'%s',s.c_str()); +477 } +478 else +479 { +480 ChanExceptSender(Channel,User,'%s',s.c_str()); +481 } +482 } .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 543 of file modules.cpp. +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 467 of file modules.cpp. .PP .nf -544 { -545 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); -546 } +468 { +469 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +470 } .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 565 of file modules.cpp. +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 489 of file modules.cpp. .PP .nf -566 { -567 if (IncludeSender) -568 { -569 WriteCommon(User,'%s',text.c_str()); -570 } -571 else -572 { -573 WriteCommonExcept(User,'%s',text.c_str()); -574 } -575 } +490 { +491 if (IncludeSender) +492 { +493 WriteCommon(User,'%s',text.c_str()); +494 } +495 else +496 { +497 WriteCommonExcept(User,'%s',text.c_str()); +498 } +499 } .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 524 of file modules.cpp. +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 448 of file modules.cpp. .PP .nf -525 { -526 WriteFrom(Socket,User,'%s',s.c_str()); -527 } +449 { +450 WriteFrom(Socket,User,'%s',s.c_str()); +451 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -944,32 +957,32 @@ 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 509 of file modules.cpp. +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 433 of file modules.cpp. .PP References server_mode(). .PP .nf -510 { -511 server_mode(parameters,pcnt,user); -512 } +434 { +435 server_mode(parameters,pcnt,user); +436 } .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 439 of file modules.cpp. +Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 363 of file modules.cpp. .PP .nf -440 { -441 WriteOpers('%s',s.c_str()); -442 } +364 { +365 WriteOpers('%s',s.c_str()); +366 } .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 519 of file modules.cpp. +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 443 of file modules.cpp. .PP .nf -520 { -521 WriteServ(Socket,'%s',s.c_str()); -522 } +444 { +445 WriteServ(Socket,'%s',s.c_str()); +446 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -981,23 +994,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 529 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 453 of file modules.cpp. .PP References connection::fd. .PP .nf -530 { -531 if (!Source) -532 { -533 // if source is NULL, then the message originates from the local server -534 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -535 } -536 else -537 { -538 // otherwise it comes from the user specified -539 WriteTo(Source,Dest,'%s',s.c_str()); -540 } -541 } +454 { +455 if (!Source) +456 { +457 // if source is NULL, then the message originates from the local server +458 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +459 } +460 else +461 { +462 // otherwise it comes from the user specified +463 WriteTo(Source,Dest,'%s',s.c_str()); +464 } +465 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -1005,46 +1018,46 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .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 452 of file modules.cpp. +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 376 of file modules.cpp. .PP .nf -453 { -454 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -455 } +377 { +378 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +379 } .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 577 of file modules.cpp. +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 501 of file modules.cpp. .PP .nf -578 { -579 WriteWallOps(User,false,'%s',text.c_str()); -580 } +502 { +503 WriteWallOps(User,false,'%s',text.c_str()); +504 } .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 681 of file modules.cpp. +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 610 of file modules.cpp. .PP References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -682 { -683 unsigned int old_fd = user->fd; -684 user->fd = FD_MAGIC_NUMBER; -685 user->ClearBuffer(); -686 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); -687 #ifdef USE_KQUEUE -688 struct kevent ke; -689 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); -690 int i = kevent(kq, &ke, 1, 0, 0, NULL); -691 if (i == -1) -692 { -693 log(DEBUG,'kqueue: Failed to remove user from queue!'); -694 } -695 #endif -696 shutdown(old_fd,2); -697 close(old_fd); -698 } +611 { +612 unsigned int old_fd = user->fd; +613 user->fd = FD_MAGIC_NUMBER; +614 user->ClearBuffer(); +615 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +616 #ifdef USE_KQUEUE +617 struct kevent ke; +618 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +619 int i = kevent(kq, &ke, 1, 0, 0, NULL); +620 if (i == -1) +621 { +622 log(DEBUG,'kqueue: Failed to remove user from queue!'); +623 } +624 #endif +625 shutdown(old_fd,2); +626 close(old_fd); +627 } .fi |