#include <modules.h>
Inherits classbase.
Public Member Functions | |
| Server () | |
| Default constructor. | |
| virtual | ~Server () |
| Default destructor. | |
| virtual void | SendOpers (std::string s) |
| Sends text to all opers. | |
| virtual void | Log (int level, std::string s) |
| Writes a log string. | |
| virtual void | Send (int Socket, std::string s) |
| Sends a line of text down a TCP/IP socket. | |
| virtual void | SendServ (int Socket, std::string s) |
| Sends text from the server to a socket. | |
| virtual void | SendFrom (int Socket, userrec *User, std::string s) |
| Sends text from a user to a socket. | |
| virtual void | SendTo (userrec *Source, userrec *Dest, std::string s) |
| Sends text from a user to another user. | |
| virtual void | SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender) |
| Sends text from a user to a channel (mulicast). | |
| virtual bool | CommonChannels (userrec *u1, userrec *u2) |
| Returns true if two users share a common channel. | |
| virtual void | SendCommon (userrec *User, std::string text, bool IncludeSender) |
| Sends text from a user to one or more channels (mulicast). | |
| virtual void | SendWallops (userrec *User, std::string text) |
| Sends a WALLOPS message. | |
| virtual bool | IsNick (std::string nick) |
| Returns true if a nick is valid. | |
| virtual int | CountUsers (chanrec *c) |
| Returns a count of the number of users on a channel. | |
| virtual userrec * | FindNick (std::string nick) |
| Attempts to look up a nick and return a pointer to it. | |
| virtual chanrec * | FindChannel (std::string channel) |
| Attempts to look up a channel and return a pointer to it. | |
| virtual std::string | ChanMode (userrec *User, chanrec *Chan) |
| Attempts to look up a user's privilages on a channel. | |
| virtual bool | IsOnChannel (userrec *User, chanrec *Chan) |
| Checks if a user is on a channel. | |
| virtual std::string | GetServerName () |
| Returns the server name of the server where the module is loaded. | |
| virtual std::string | GetNetworkName () |
| Returns the network name, global to all linked servers. | |
| virtual Admin | GetAdmin () |
| Returns the information of the server as returned by the /ADMIN command. | |
| virtual bool | AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) |
| Adds an extended mode letter which is parsed by a module. | |
| virtual bool | AddExtendedListMode (char modechar) |
| Adds an extended mode letter which is parsed by a module and handled in a list fashion. | |
| virtual void | AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) |
| Adds a command to the command table. | |
| virtual void | SendMode (char **parameters, int pcnt, userrec *user) |
| Sends a servermode. | |
| virtual void | SendToModeMask (std::string modes, int flags, std::string text) |
| Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. | |
| virtual chanrec * | JoinUserToChannel (userrec *user, std::string cname, std::string key) |
| Forces a user to join a channel. | |
| virtual chanrec * | PartUserFromChannel (userrec *user, std::string cname, std::string reason) |
| Forces a user to part a channel. | |
| virtual void | ChangeUserNick (userrec *user, std::string nickname) |
| Forces a user nickchange. | |
| virtual void | QuitUser (userrec *user, std::string reason) |
| Forces a user to quit with the specified reason. | |
| virtual bool | MatchText (std::string sliteral, std::string spattern) |
| Matches text against a glob pattern. | |
| virtual void | CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user) |
| Calls the handler for a command, either implemented by the core or by another module. | |
| virtual void | ChangeHost (userrec *user, std::string host) |
| Change displayed hostname of a user. | |
| virtual void | ChangeGECOS (userrec *user, std::string gecos) |
| Change GECOS (fullname) of a user. | |
| virtual bool | IsUlined (std::string server) |
| Returns true if the servername you give is ulined. | |
| virtual chanuserlist | GetUsers (chanrec *chan) |
| Fetches the userlist of a channel. | |
| virtual bool | UserToPseudo (userrec *user, std::string message) |
| Remove a user's connection to the irc server, but leave their client in existence in the user hash. | |
| virtual bool | PseudoToUser (userrec *alive, userrec *zombie, std::string message) |
| This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other. | |
| virtual void | AddGLine (long duration, std::string source, std::string reason, std::string hostmask) |
| Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. | |
| virtual void | AddQLine (long duration, std::string source, std::string reason, std::string nickname) |
| Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. | |
| virtual void | AddZLine (long duration, std::string source, std::string reason, std::string ipaddr) |
| Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. | |
| virtual void | AddKLine (long duration, std::string source, std::string reason, std::string hostmask) |
| Adds a K-line The K-line is enforced as soon as it is added. | |
| virtual void | AddELine (long duration, std::string source, std::string reason, std::string hostmask) |
| Adds a E-line The E-line is enforced as soon as it is added. | |
| virtual bool | DelGLine (std::string hostmask) |
| Deletes a G-Line from all servers on the mesh. | |
| virtual bool | DelQLine (std::string nickname) |
| Deletes a Q-Line from all servers on the mesh. | |
| virtual bool | DelZLine (std::string ipaddr) |
| Deletes a Z-Line from all servers on the mesh. | |
| virtual bool | DelKLine (std::string hostmask) |
| Deletes a local K-Line. | |
| virtual bool | DelELine (std::string hostmask) |
| Deletes a local E-Line. | |
| virtual long | CalcDuration (std::string duration) |
| Calculates a duration This method will take a string containing a formatted duration (e.g. | |
| virtual bool | IsValidMask (std::string mask) |
| Returns true if a nick!ident string is correctly formatted, false if otherwise. | |
| virtual void | MeshSendAll (std::string text) |
| Sends a line of text to all connected servers. | |
| virtual void | MeshSendCommon (userrec *user, std::string text) |
| This method sends a line of text to all servers who have users which share common channels with the user you provide. | |
| virtual void | MeshSendAllAlive (std::string text) |
| This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. | |
| virtual void | MeshSendUnicast (std::string destination, std::string text) |
| This function sends a line of text directly to a server. | |
| virtual void | MeshSendAllExcept (std::string target, std::string text) |
| This function sends to all servers EXCEPT the one you specify. | |
| virtual bool | MeshCheckChan (chanrec *c, std::string servername) |
| This function is used to check if any users on channel c are on server servername. | |
| virtual bool | MeshCheckCommon (userrec *u, std::string servername) |
| This function is used to check if user u has any channels in common with users on servername. | |
| virtual Module * | FindModule (std::string name) |
| This function finds a module by name. | |
All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
Definition at line 652 of file modules.h.
|
|
Default constructor. Creates a Server object. Definition at line 416 of file modules.cpp.
00417 {
00418 }
|
|
|
Default destructor. Destroys a Server object. Definition at line 420 of file modules.cpp.
00421 {
00422 }
|
|
||||||||||||||||||||||||
|
Adds a command to the command table. This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc: typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user) When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded. Definition at line 497 of file modules.cpp. References createcommand().
00498 {
00499 createcommand(cmd,f,flags,minparams,source);
00500 }
|
|
||||||||||||||||||||
|
Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 715 of file modules.cpp. References add_eline(), and duration().
00716 {
00717 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00718 }
|
|
|
Adds an extended mode letter which is parsed by a module and handled in a list fashion. This call is used to implement modes like +q and +a. The characteristics of these modes are as follows: (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL (2) They always take exactly one parameter when being added or removed (3) They can be set multiple times, usually on users in channels (4) The mode and its parameter are NOT stored in the channels modes structure It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing. Definition at line 642 of file modules.cpp. References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00643 {
00644 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
00645 if (res)
00646 ModeMakeList(modechar);
00647 return res;
00648 }
|
|
||||||||||||||||||||||||
|
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 622 of file modules.cpp. References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
00623 {
00624 if (type == MT_SERVER)
00625 {
00626 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
00627 return false;
00628 }
00629 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
00630 {
00631 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
00632 return false;
00633 }
00634 if ((params_when_on>1) || (params_when_off>1))
00635 {
00636 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
00637 return false;
00638 }
00639 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
00640 }
|
|
||||||||||||||||||||
|
Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 695 of file modules.cpp. References add_gline(), and duration().
00696 {
00697 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00698 }
|
|
||||||||||||||||||||
|
Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 710 of file modules.cpp. References add_kline(), and duration().
00711 {
00712 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
00713 }
|
|
||||||||||||||||||||
|
Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 700 of file modules.cpp. References add_qline(), and duration().
00701 {
00702 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
00703 }
|
|
||||||||||||||||||||
|
Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 705 of file modules.cpp. References add_zline(), and duration().
00706 {
00707 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
00708 }
|
|
|
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 745 of file modules.cpp. References duration().
00746 {
00747 return duration(delta.c_str());
00748 }
|
|
||||||||||||||||||||
|
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 Definition at line 487 of file modules.cpp.
00488 {
00489 call_handler(commandname.c_str(),parameters,pcnt,user);
00490 }
|
|
||||||||||||
|
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 575 of file modules.cpp. References ChangeName().
00576 {
00577 ChangeName(user,gecos.c_str());
00578 }
|
|
||||||||||||
|
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 570 of file modules.cpp. References ChangeDisplayedHost().
00571 {
00572 ChangeDisplayedHost(user,host.c_str());
00573 }
|
|
||||||||||||
|
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 471 of file modules.cpp.
00472 {
00473 force_nickchange(user,nickname.c_str());
00474 }
|
|
||||||||||||
|
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 595 of file modules.cpp. References cmode().
00596 {
00597 return cmode(User,Chan);
00598 }
|
|
||||||||||||
|
Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method. Definition at line 548 of file modules.cpp. References common_channels().
00549 {
00550 return (common_channels(u1,u2) != 0);
00551 }
|
|
|
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 650 of file modules.cpp.
00651 {
00652 return usercount(c);
00653 }
|
|
|
Deletes a local E-Line.
Definition at line 740 of file modules.cpp. References del_eline().
00741 {
00742 del_eline(hostmask.c_str());
00743 }
|
|
|
Deletes a G-Line from all servers on the mesh.
Definition at line 720 of file modules.cpp. References del_gline().
00721 {
00722 del_gline(hostmask.c_str());
00723 }
|
|
|
Deletes a local K-Line.
Definition at line 735 of file modules.cpp. References del_kline().
00736 {
00737 del_kline(hostmask.c_str());
00738 }
|
|
|
Deletes a Q-Line from all servers on the mesh.
Definition at line 725 of file modules.cpp. References del_qline().
00726 {
00727 del_qline(nickname.c_str());
00728 }
|
|
|
Deletes a Z-Line from all servers on the mesh.
Definition at line 730 of file modules.cpp. References del_zline().
00731 {
00732 del_zline(ipaddr.c_str());
00733 }
|
|
|
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 590 of file modules.cpp.
00591 {
00592 return FindChan(channel.c_str());
00593 }
|
|
|
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 823 of file modules.cpp. References MODCOUNT, module_names, and modules.
00824 {
00825 for (int i = 0; i <= MODCOUNT; i++)
00826 {
00827 if (module_names[i] == name)
00828 {
00829 return modules[i];
00830 }
00831 }
00832 return NULL;
00833 }
|
|
|
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 585 of file modules.cpp.
00586 {
00587 return Find(nick);
00588 }
|
|
|
Returns the information of the server as returned by the /ADMIN command. See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded. Definition at line 615 of file modules.cpp.
00616 {
00617 return Admin(getadminname(),getadminemail(),getadminnick());
00618 }
|
|
|
Returns the network name, global to all linked servers.
Definition at line 610 of file modules.cpp.
00611 {
00612 return getnetworkname();
00613 }
|
|
|
Returns the server name of the server where the module is loaded.
Definition at line 605 of file modules.cpp.
00606 {
00607 return getservername();
00608 }
|
|
|
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 452 of file modules.cpp. References chanuserlist, clientlist, has_channel(), and isnick().
00453 {
00454 chanuserlist userl;
00455 userl.clear();
00456 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
00457 {
00458 if (i->second)
00459 {
00460 if (has_channel(i->second,chan))
00461 {
00462 if (isnick(i->second->nick))
00463 {
00464 userl.push_back(i->second);
00465 }
00466 }
00467 }
00468 }
00469 return userl;
00470 }
|
|
|
Returns true if a nick is valid. Nicks for unregistered connections will return false. Definition at line 580 of file modules.cpp. References isnick().
00581 {
00582 return (isnick(nick.c_str()) != 0);
00583 }
|
|
||||||||||||
|
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 600 of file modules.cpp. References has_channel().
00601 {
00602 return has_channel(User,Chan);
00603 }
|
|
|
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 482 of file modules.cpp. References is_uline().
00483 {
00484 return is_uline(server.c_str());
00485 }
|
|
|
Returns true if a nick!ident string is correctly formatted, false if otherwise.
Definition at line 750 of file modules.cpp.
00751 {
00752 const char* dest = mask.c_str();
00753 if (strchr(dest,'!')==0)
00754 return false;
00755 if (strchr(dest,'@')==0)
00756 return false;
00757 for (int i = 0; i < strlen(dest); i++)
00758 if (dest[i] < 32)
00759 return false;
00760 for (int i = 0; i < strlen(dest); i++)
00761 if (dest[i] > 126)
00762 return false;
00763 int c = 0;
00764 for (int i = 0; i < strlen(dest); i++)
00765 if (dest[i] == '!')
00766 c++;
00767 if (c>1)
00768 return false;
00769 c = 0;
00770 for (int i = 0; i < strlen(dest); i++)
00771 if (dest[i] == '@')
00772 c++;
00773 if (c>1)
00774 return false;
00775
00776 return true;
00777 }
|
|
||||||||||||||||
|
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 442 of file modules.cpp.
00443 {
00444 return add_channel(user,cname.c_str(),key.c_str(),true);
00445 }
|
|
||||||||||||
|
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 492 of file modules.cpp.
00493 {
00494 log(level,"%s",s.c_str());
00495 }
|
|
||||||||||||
|
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 429 of file modules.cpp.
00430 {
00431 char literal[MAXBUF],pattern[MAXBUF];
00432 strlcpy(literal,sliteral.c_str(),MAXBUF);
00433 strlcpy(pattern,spattern.c_str(),MAXBUF);
00434 return match(literal,pattern);
00435 }
|
|
||||||||||||
|
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 805 of file modules.cpp.
00806 {
00807 if (c)
00808 {
00809 return ChanAnyOnThisServer(c,(char*)servername.c_str());
00810 }
00811 else return false;
00812 }
|
|
||||||||||||
|
This function is used to check if user u has any channels in common with users on servername. This is used internally by Server::MeshSendCommon. You should very rarely need to use it. Definition at line 814 of file modules.cpp.
00815 {
00816 if (u)
00817 {
00818 return CommonOnThisServer(u,(char*)servername.c_str());
00819 }
00820 else return false;
00821 }
|
|
|
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 779 of file modules.cpp.
00780 {
00781 NetSendToAll((char*)text.c_str());
00782 }
|
|
|
This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable.
Definition at line 790 of file modules.cpp.
00791 {
00792 NetSendToAllAlive((char*)text.c_str());
00793 }
|
|
||||||||||||
|
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 800 of file modules.cpp.
00801 {
00802 NetSendToAllExcept(target.c_str(),(char*)text.c_str());
00803 }
|
|
||||||||||||
|
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 784 of file modules.cpp.
00785 {
00786 if (user)
00787 NetSendToCommon(user,(char*)text.c_str());
00788 }
|
|
||||||||||||
|
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 795 of file modules.cpp.
00796 {
00797 NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
00798 }
|
|
||||||||||||||||
|
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 447 of file modules.cpp.
00448 {
00449 return del_channel(user,cname.c_str(),reason.c_str(),false);
00450 }
|
|
||||||||||||||||
|
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 665 of file modules.cpp. References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
00666 {
00667 zombie->fd = alive->fd;
00668 alive->fd = FD_MAGIC_NUMBER;
00669 Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
00670 kill_link(alive,message.c_str());
00671 for (int i = 0; i != MAXCHANS; i++)
00672 {
00673 if (zombie->chans[i].channel != NULL)
00674 {
00675 if (zombie->chans[i].channel->name)
00676 {
00677 chanrec* Ptr = zombie->chans[i].channel;
00678 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
00679 if (Ptr->topicset)
00680 {
00681 WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
00682 WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
00683 }
00684 userlist(zombie,Ptr);
00685 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
00686 //WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
00687 //WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
00688
00689 }
00690 }
00691 }
00692
00693 }
|
|
||||||||||||
|
Forces a user to quit with the specified reason. To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file. WARNING! Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler. Definition at line 476 of file modules.cpp. References userrec::nick, and send_network_quit().
00477 {
00478 send_network_quit(user->nick,reason.c_str());
00479 kill_link(user,reason.c_str());
00480 }
|
|
||||||||||||
|
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 507 of file modules.cpp.
00508 {
00509 Write(Socket,"%s",s.c_str());
00510 }
|
|
||||||||||||||||||||
|
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 536 of file modules.cpp.
00537 {
00538 if (IncludeSender)
00539 {
00540 WriteChannel(Channel,User,"%s",s.c_str());
00541 }
00542 else
00543 {
00544 ChanExceptSender(Channel,User,"%s",s.c_str());
00545 }
00546 }
|
|
||||||||||||||||
|
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 553 of file modules.cpp.
00554 {
00555 if (IncludeSender)
00556 {
00557 WriteCommon(User,"%s",text.c_str());
00558 }
00559 else
00560 {
00561 WriteCommonExcept(User,"%s",text.c_str());
00562 }
00563 }
|
|
||||||||||||||||
|
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 517 of file modules.cpp.
00518 {
00519 WriteFrom(Socket,User,"%s",s.c_str());
00520 }
|
|
||||||||||||||||
|
Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes. For example: char *modes[3]; modes[0] = ChannelName; modes[1] = "+o"; modes[2] = user->nick; Srv->SendMode(modes,3,user); The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state! Definition at line 502 of file modules.cpp. References server_mode().
00503 {
00504 server_mode(parameters,pcnt,user);
00505 }
|
|
|
Sends text to all opers. This method sends a server notice to all opers with the usermode +s. Definition at line 424 of file modules.cpp.
00425 {
00426 WriteOpers("%s",s.c_str());
00427 }
|
|
||||||||||||
|
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 512 of file modules.cpp.
00513 {
00514 WriteServ(Socket,"%s",s.c_str());
00515 }
|
|
||||||||||||||||
|
Sends text from a user to another user. This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of: :user!ident TEXT The format will become: :localserver TEXT Which is useful for numerics and server notices to single users, etc. Definition at line 522 of file modules.cpp. References connection::fd.
00523 {
00524 if (!Source)
00525 {
00526 // if source is NULL, then the message originates from the local server
00527 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
00528 }
00529 else
00530 {
00531 // otherwise it comes from the user specified
00532 WriteTo(Source,Dest,"%s",s.c_str());
00533 }
00534 }
|
|
||||||||||||||||
|
Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use: Serv->SendToModeMask("xi", WM_OR, "m00"); Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message. Definition at line 437 of file modules.cpp.
00438 {
00439 WriteMode(modes.c_str(),flags,"%s",text.c_str());
00440 }
|
|
||||||||||||
|
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 565 of file modules.cpp.
00566 {
00567 WriteWallOps(User,false,"%s",text.c_str());
00568 }
|
|
||||||||||||
|
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 656 of file modules.cpp. References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
00657 {
00658 unsigned int old_fd = user->fd;
00659 user->fd = FD_MAGIC_NUMBER;
00660 Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
00661 close(old_fd);
00662 shutdown (old_fd,2);
00663 }
|
1.3.3