From bab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 9 Dec 2005 20:21:39 +0000 Subject: Added new module docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 793 ++++++++++++++++++++++----------------- 1 file changed, 441 insertions(+), 352 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 8285fb2d6..f71644ac0 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -126,6 +126,8 @@ Inheritance diagram for Server:

virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)  Calls the handler for a command, either implemented by the core or by another module.
+virtual bool IsValidModuleCommand (std::string commandname, int pcnt, userrec *user) + virtual void ChangeHost (userrec *user, std::string host)  Change displayed hostname of a user.
@@ -189,6 +191,8 @@ Inheritance diagram for Server:

virtual void DelSocket (InspSocket *sock)  Deletes a class derived from InspSocket from the server's socket engine.
+virtual void RehashServer () +

Detailed Description

Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. @@ -197,7 +201,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 696 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1081 of file modules.h.

Constructor & Destructor Documentation

@@ -226,8 +230,8 @@ Default constructor.

Creates a Server object.

-Definition at line 367 of file modules.cpp.

00368 {
-00369 }
+Definition at line 394 of file modules.cpp.
00395 {
+00396 }
 

 

     
@@ -261,8 +265,8 @@ Default destructor.
 

 Destroys a Server object.
 

-Definition at line 371 of file modules.cpp.
00372 {
-00373 }
+Definition at line 398 of file modules.cpp.
00399 {
+00400 }
 

 

     
@@ -327,11 +331,11 @@ This allows modules to add extra commands into the command table. You must place
 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 457 of file modules.cpp.
+Definition at line 495 of file modules.cpp.
 

-References createcommand().
00458 {
-00459         createcommand(cmd,f,flags,minparams,source);
-00460 }
+References createcommand().
00496 {
+00497         createcommand(cmd,f,flags,minparams,source);
+00498 }
 

 

     
@@ -387,11 +391,11 @@ 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 720 of file modules.cpp.
+Definition at line 758 of file modules.cpp.
 

-References add_eline().
00721 {
-00722         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00723 }
+References add_eline().
00759 {
+00760         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00761 }
 

 

     
@@ -431,14 +435,14 @@ This call is used to implement modes like +q and +a. The characteristics of thes
 (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 625 of file modules.cpp.
+Definition at line 663 of file modules.cpp.
 

-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00626 {
-00627         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00628         if (res)
-00629                 ModeMakeList(modechar);
-00630         return res;
-00631 }
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00664 {
+00665         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00666         if (res)
+00667                 ModeMakeList(modechar);
+00668         return res;
+00669 }
 

 

     
@@ -500,34 +504,34 @@ 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 597 of file modules.cpp.
-

-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
00598 {
-00599         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-00600         {
-00601                 if (type == MT_SERVER)
-00602                 {
-00603                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00604                         return false;
-00605                 }
-00606                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00607                 {
-00608                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00609                         return false;
-00610                 }
-00611                 if ((params_when_on>1) || (params_when_off>1))
-00612                 {
-00613                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00614                         return false;
-00615                 }
-00616                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00617         }
-00618         else
-00619         {
-00620                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
-00621         }
-00622         return false;
-00623 }
+Definition at line 635 of file modules.cpp.
+

+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
00636 {
+00637         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+00638         {
+00639                 if (type == MT_SERVER)
+00640                 {
+00641                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00642                         return false;
+00643                 }
+00644                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00645                 {
+00646                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00647                         return false;
+00648                 }
+00649                 if ((params_when_on>1) || (params_when_off>1))
+00650                 {
+00651                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00652                         return false;
+00653                 }
+00654                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00655         }
+00656         else
+00657         {
+00658                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
+00659         }
+00660         return false;
+00661 }
 

 

     
@@ -583,11 +587,11 @@ Adds a G-line The G-line is propogated to all of the servers in the mesh and enf
 

 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.
+Definition at line 738 of file modules.cpp.
 

-References add_gline().
00701 {
-00702         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00703 }
+References add_gline().
00739 {
+00740         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00741 }
 

 

     
@@ -643,11 +647,11 @@ 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 715 of file modules.cpp.
+Definition at line 753 of file modules.cpp.
 

-References add_kline().
00716 {
-00717         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00718 }
+References add_kline().
00754 {
+00755         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00756 }
 

 

     
@@ -703,11 +707,11 @@ Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enf
 

 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.
+Definition at line 743 of file modules.cpp.
 

-References add_qline().
00706 {
-00707         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00708 }
+References add_qline().
00744 {
+00745         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00746 }
 

 

     
@@ -742,11 +746,11 @@ Adds a class derived from InspSocket
 
 

-Definition at line 375 of file modules.cpp.
+Definition at line 402 of file modules.cpp.
 

-References module_sockets.
00376 {
-00377         module_sockets.push_back(sock);
-00378 }
+References module_sockets.
00403 {
+00404         module_sockets.push_back(sock);
+00405 }
 

 

     
@@ -802,11 +806,11 @@ Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enf
 

 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.
+Definition at line 748 of file modules.cpp.
 

-References add_zline().
00711 {
-00712         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00713 }
+References add_zline().
00749 {
+00750         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00751 }
 

 

     
@@ -841,11 +845,11 @@ Calculates a duration This method will take a string containing a formatted dura
 

 "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 750 of file modules.cpp.
+Definition at line 788 of file modules.cpp.
 

-References duration().
00751 {
-00752         return duration(delta.c_str());
-00753 }
+References duration().
00789 {
+00790         return duration(delta.c_str());
+00791 }
 

 

     
@@ -902,9 +906,9 @@ Calls the handler for a command, either implemented by the core or by another mo
 You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a  or 

 ) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.
 

-Definition at line 447 of file modules.cpp.
00448 {
-00449         call_handler(commandname.c_str(),parameters,pcnt,user);
-00450 }
+Definition at line 480 of file modules.cpp.
00481 {
+00482         call_handler(commandname.c_str(),parameters,pcnt,user);
+00483 }
 

 

     
@@ -948,11 +952,11 @@ 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 540 of file modules.cpp.
+Definition at line 578 of file modules.cpp.
 

-References ChangeName().
00541 {
-00542         ChangeName(user,gecos.c_str());
-00543 }
+References ChangeName().
00579 {
+00580         ChangeName(user,gecos.c_str());
+00581 }
 

 

     
@@ -996,11 +1000,11 @@ 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 535 of file modules.cpp.
+Definition at line 573 of file modules.cpp.
 

-References ChangeDisplayedHost().
00536 {
-00537         ChangeDisplayedHost(user,host.c_str());
-00538 }
+References ChangeDisplayedHost().
00574 {
+00575         ChangeDisplayedHost(user,host.c_str());
+00576 }
 

 

     
@@ -1044,9 +1048,9 @@ 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 432 of file modules.cpp.
00433 {
-00434         force_nickchange(user,nickname.c_str());
-00435 }
+Definition at line 465 of file modules.cpp.
00466 {
+00467         force_nickchange(user,nickname.c_str());
+00468 }
 

 

     
@@ -1090,11 +1094,11 @@ 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 565 of file modules.cpp.
+Definition at line 603 of file modules.cpp.
 

-References cmode().
00566 {
-00567         return cmode(User,Chan);
-00568 }
+References cmode().
00604 {
+00605         return cmode(User,Chan);
+00606 }
 

 

     
@@ -1138,11 +1142,11 @@ 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 513 of file modules.cpp.
+Definition at line 551 of file modules.cpp.
 

-References common_channels().
00514 {
-00515         return (common_channels(u1,u2) != 0);
-00516 }
+References common_channels().
00552 {
+00553         return (common_channels(u1,u2) != 0);
+00554 }
 

 

     
@@ -1177,9 +1181,9 @@ 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 633 of file modules.cpp.
00634 {
-00635         return usercount(c);
-00636 }
+Definition at line 671 of file modules.cpp.
00672 {
+00673         return usercount(c);
+00674 }
 

 

     
@@ -1214,11 +1218,11 @@ Deletes a local E-Line.
 

 
 

-Definition at line 745 of file modules.cpp.
+Definition at line 783 of file modules.cpp.
 

-References del_eline().
00746 {
-00747         return del_eline(hostmask.c_str());
-00748 }
+References del_eline().
00784 {
+00785         return del_eline(hostmask.c_str());
+00786 }
 

 

     
@@ -1253,11 +1257,11 @@ Deletes a G-Line from all servers on the mesh.
 

 
 

-Definition at line 725 of file modules.cpp.
+Definition at line 763 of file modules.cpp.
 

-References del_gline().
00726 {
-00727         return del_gline(hostmask.c_str());
-00728 }
+References del_gline().
00764 {
+00765         return del_gline(hostmask.c_str());
+00766 }
 

 

     
@@ -1292,11 +1296,11 @@ Deletes a local K-Line.
 

 
 

-Definition at line 740 of file modules.cpp.
+Definition at line 778 of file modules.cpp.
 

-References del_kline().
00741 {
-00742         return del_kline(hostmask.c_str());
-00743 }
+References del_kline().
00779 {
+00780         return del_kline(hostmask.c_str());
+00781 }
 

 

     
@@ -1331,11 +1335,11 @@ Deletes a Q-Line from all servers on the mesh.
 

 
 

-Definition at line 730 of file modules.cpp.
+Definition at line 768 of file modules.cpp.
 

-References del_qline().
00731 {
-00732         return del_qline(nickname.c_str());
-00733 }
+References del_qline().
00769 {
+00770         return del_qline(nickname.c_str());
+00771 }
 

 

     
@@ -1370,18 +1374,18 @@ Deletes a class derived from InspSocke
 

 
 

-Definition at line 380 of file modules.cpp.
+Definition at line 413 of file modules.cpp.
 

-References module_sockets.
00381 {
-00382         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
-00383         {
-00384                 if (*a == sock)
-00385                 {
-00386                         module_sockets.erase(a);
-00387                         return;
-00388                 }
-00389         }
-00390 }
+References module_sockets.
00414 {
+00415         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
+00416         {
+00417                 if (*a == sock)
+00418                 {
+00419                         module_sockets.erase(a);
+00420                         return;
+00421                 }
+00422         }
+00423 }
 

 

     
@@ -1416,11 +1420,11 @@ Deletes a Z-Line from all servers on the mesh.
 

 
 

-Definition at line 735 of file modules.cpp.
+Definition at line 773 of file modules.cpp.
 

-References del_zline().
00736 {
-00737         return del_zline(ipaddr.c_str());
-00738 }
+References del_zline().
00774 {
+00775         return del_zline(ipaddr.c_str());
+00776 }
 

 

     
@@ -1455,9 +1459,9 @@ 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 560 of file modules.cpp.
00561 {
-00562         return FindChan(channel.c_str());
-00563 }
+Definition at line 598 of file modules.cpp.
00599 {
+00600         return FindChan(channel.c_str());
+00601 }
 

 

     
@@ -1492,9 +1496,9 @@ 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 555 of file modules.cpp.
00556 {
-00557         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00558 }
+Definition at line 593 of file modules.cpp.
00594 {
+00595         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00596 }
 

 

     
@@ -1529,18 +1533,18 @@ 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 784 of file modules.cpp.
-

-References MODCOUNT, module_names, and modules.
00785 {
-00786         for (int i = 0; i <= MODCOUNT; i++)
-00787         {
-00788                 if (module_names[i] == name)
-00789                 {
-00790                         return modules[i];
-00791                 }
-00792         }
-00793         return NULL;
-00794 }
+Definition at line 822 of file modules.cpp.
+

+References MODCOUNT, module_names, and modules.
00823 {
+00824         for (int i = 0; i <= MODCOUNT; i++)
+00825         {
+00826                 if (module_names[i] == name)
+00827                 {
+00828                         return modules[i];
+00829                 }
+00830         }
+00831         return NULL;
+00832 }
 

 

     
@@ -1575,9 +1579,9 @@ 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 550 of file modules.cpp.
00551 {
-00552         return Find(nick);
-00553 }
+Definition at line 588 of file modules.cpp.
00589 {
+00590         return Find(nick);
+00591 }
 

 

     
@@ -1611,9 +1615,9 @@ 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 590 of file modules.cpp.
00591 {
-00592         return Admin(getadminname(),getadminemail(),getadminnick());
-00593 }
+Definition at line 628 of file modules.cpp.
00629 {
+00630         return Admin(getadminname(),getadminemail(),getadminnick());
+00631 }
 

 

     
@@ -1647,9 +1651,9 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 580 of file modules.cpp.
00581 {
-00582         return getnetworkname();
-00583 }
+Definition at line 618 of file modules.cpp.
00619 {
+00620         return getnetworkname();
+00621 }
 

 

     
@@ -1683,9 +1687,9 @@ Returns the server description string of the local server.
 

 
 

-Definition at line 585 of file modules.cpp.
00586 {
-00587         return getserverdesc();
-00588 }
+Definition at line 623 of file modules.cpp.
00624 {
+00625         return getserverdesc();
+00626 }
 

 

     
@@ -1719,9 +1723,9 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 575 of file modules.cpp.
00576 {
-00577         return getservername();
-00578 }
+Definition at line 613 of file modules.cpp.
00614 {
+00615         return getservername();
+00616 }
 

 

     
@@ -1756,19 +1760,19 @@ 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 420 of file modules.cpp.
-

-References chanrec::GetUsers(), and list.
00421 {
-00422         chanuserlist userl;
-00423         userl.clear();
-00424         std::vector<char*> *list = chan->GetUsers();
-00425         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-00426         {
-00427                 char* o = *i;
-00428                 userl.push_back((userrec*)o);
-00429         }
-00430         return userl;
-00431 }
+Definition at line 453 of file modules.cpp.
+

+References chanrec::GetUsers(), and list.
00454 {
+00455         chanuserlist userl;
+00456         userl.clear();
+00457         std::vector<char*> *list = chan->GetUsers();
+00458         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00459         {
+00460                 char* o = *i;
+00461                 userl.push_back((userrec*)o);
+00462         }
+00463         return userl;
+00464 }
 

 

     
@@ -1803,11 +1807,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 545 of file modules.cpp.
+Definition at line 583 of file modules.cpp.
 

-References isnick().
00546 {
-00547         return (isnick(nick.c_str()) != 0);
-00548 }
+References isnick().
00584 {
+00585         return (isnick(nick.c_str()) != 0);
+00586 }
 

 

     
@@ -1851,11 +1855,11 @@ 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 570 of file modules.cpp.
+Definition at line 608 of file modules.cpp.
 

-References has_channel().
00571 {
-00572         return has_channel(User,Chan);
-00573 }
+References has_channel().
00609 {
+00610         return has_channel(User,Chan);
+00611 }
 

 

     
@@ -1890,11 +1894,11 @@ 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 442 of file modules.cpp.
+Definition at line 475 of file modules.cpp.
 

-References is_uline().
00443 {
-00444         return is_uline(server.c_str());
-00445 }
+References is_uline().
00476 {
+00477         return is_uline(server.c_str());
+00478 }
 

 

     
@@ -1929,33 +1933,83 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
 

 
 

-Definition at line 755 of file modules.cpp.
00756 {
-00757         const char* dest = mask.c_str();
-00758         if (strchr(dest,'!')==0)
-00759                 return false;
-00760         if (strchr(dest,'@')==0)
-00761                 return false;
-00762         for (unsigned int i = 0; i < strlen(dest); i++)
-00763                 if (dest[i] < 32)
-00764                         return false;
-00765         for (unsigned int i = 0; i < strlen(dest); i++)
-00766                 if (dest[i] > 126)
-00767                         return false;
-00768         unsigned int c = 0;
-00769         for (unsigned int i = 0; i < strlen(dest); i++)
-00770                 if (dest[i] == '!')
-00771                         c++;
-00772         if (c>1)
-00773                 return false;
-00774         c = 0;
-00775         for (unsigned int i = 0; i < strlen(dest); i++)
-00776                 if (dest[i] == '@')
-00777                         c++;
-00778         if (c>1)
-00779                 return false;
-00780 
-00781         return true;
-00782 }
+Definition at line 793 of file modules.cpp.
00794 {
+00795         const char* dest = mask.c_str();
+00796         if (strchr(dest,'!')==0)
+00797                 return false;
+00798         if (strchr(dest,'@')==0)
+00799                 return false;
+00800         for (unsigned int i = 0; i < strlen(dest); i++)
+00801                 if (dest[i] < 32)
+00802                         return false;
+00803         for (unsigned int i = 0; i < strlen(dest); i++)
+00804                 if (dest[i] > 126)
+00805                         return false;
+00806         unsigned int c = 0;
+00807         for (unsigned int i = 0; i < strlen(dest); i++)
+00808                 if (dest[i] == '!')
+00809                         c++;
+00810         if (c>1)
+00811                 return false;
+00812         c = 0;
+00813         for (unsigned int i = 0; i < strlen(dest); i++)
+00814                 if (dest[i] == '@')
+00815                         c++;
+00816         if (c>1)
+00817                 return false;
+00818 
+00819         return true;
+00820 }
+

+

+    
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool Server::IsValidModuleCommand ( std::string  commandname,
int  pcnt,
userrec *  user
)  [virtual]
+
+ + + + @@ -2005,9 +2059,9 @@ 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 410 of file modules.cpp.

00411 {
-00412         return add_channel(user,cname.c_str(),key.c_str(),false);
-00413 }
+Definition at line 443 of file modules.cpp.
00444 {
+00445         return add_channel(user,cname.c_str(),key.c_str(),false);
+00446 }
 

 

     
@@ -2051,9 +2105,9 @@ 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 452 of file modules.cpp.
00453 {
-00454         log(level,"%s",s.c_str());
-00455 }
+Definition at line 490 of file modules.cpp.
00491 {
+00492         log(level,"%s",s.c_str());
+00493 }
 

 

     
@@ -2097,12 +2151,12 @@ 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 397 of file modules.cpp.
00398 {
-00399         char literal[MAXBUF],pattern[MAXBUF];
-00400         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00401         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00402         return match(literal,pattern);
-00403 }
+Definition at line 430 of file modules.cpp.
00431 {
+00432         char literal[MAXBUF],pattern[MAXBUF];
+00433         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00434         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00435         return match(literal,pattern);
+00436 }
 

 

     
@@ -2152,9 +2206,9 @@ 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 415 of file modules.cpp.
00416 {
-00417         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00418 }
+Definition at line 448 of file modules.cpp.
00449 {
+00450         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00451 }
 

 

     
@@ -2204,36 +2258,36 @@ This user takes one user, and switches their file descriptor with another user,
 

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

-References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
00671 {
-00672         zombie->fd = alive->fd;
-00673         alive->fd = FD_MAGIC_NUMBER;
-00674         alive->ClearBuffer();
-00675         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00676         kill_link(alive,message.c_str());
-00677         fd_ref_table[zombie->fd] = zombie;
-00678         for (int i = 0; i != MAXCHANS; i++)
-00679         {
-00680                 if (zombie->chans[i].channel != NULL)
-00681                 {
-00682                         if (zombie->chans[i].channel->name)
-00683                         {
-00684                                 chanrec* Ptr = zombie->chans[i].channel;
-00685                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00686                                 if (Ptr->topicset)
-00687                                 {
-00688                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00689                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00690                                 }
-00691                                 userlist(zombie,Ptr);
-00692                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00693 
-00694                         }
-00695                 }
-00696         }
-00697         return true;
-00698 }
+Definition at line 708 of file modules.cpp.
+

+References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
00709 {
+00710         zombie->fd = alive->fd;
+00711         alive->fd = FD_MAGIC_NUMBER;
+00712         alive->ClearBuffer();
+00713         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00714         kill_link(alive,message.c_str());
+00715         fd_ref_table[zombie->fd] = zombie;
+00716         for (int i = 0; i != MAXCHANS; i++)
+00717         {
+00718                 if (zombie->chans[i].channel != NULL)
+00719                 {
+00720                         if (zombie->chans[i].channel->name)
+00721                         {
+00722                                 chanrec* Ptr = zombie->chans[i].channel;
+00723                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00724                                 if (Ptr->topicset)
+00725                                 {
+00726                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00727                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00728                                 }
+00729                                 userlist(zombie,Ptr);
+00730                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00731 
+00732                         }
+00733                 }
+00734         }
+00735         return true;
+00736 }
 

 

     
@@ -2279,9 +2333,44 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa
 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 437 of file modules.cpp.
00438 {
-00439         kill_link(user,reason.c_str());
-00440 }
+Definition at line 470 of file modules.cpp.
00471 {
+00472         kill_link(user,reason.c_str());
+00473 }
+

+

+    
+
+
+   + + +

+ +

+Definition at line 485 of file modules.cpp.

00486 {
+00487         return is_valid_cmd(commandname.c_str(), pcnt, user);
+00488 }

+

+ + + + +
+ + + + + + + + +
void Server::RehashServer (   )  [virtual]
+
+ + + + @@ -2325,9 +2414,9 @@ 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 467 of file modules.cpp.

00468 {
-00469         Write(Socket,"%s",s.c_str());
-00470 }
+Definition at line 505 of file modules.cpp.
00506 {
+00507         Write(Socket,"%s",s.c_str());
+00508 }
 

 

     
@@ -2383,16 +2472,16 @@ 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 501 of file modules.cpp.
00502 {
-00503         if (IncludeSender)
-00504         {
-00505                 WriteChannel(Channel,User,"%s",s.c_str());
-00506         }
-00507         else
-00508         {
-00509                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00510         }
-00511 }
+Definition at line 539 of file modules.cpp.
00540 {
+00541         if (IncludeSender)
+00542         {
+00543                 WriteChannel(Channel,User,"%s",s.c_str());
+00544         }
+00545         else
+00546         {
+00547                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00548         }
+00549 }
 

 

     
@@ -2442,9 +2531,9 @@ 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 496 of file modules.cpp.
00497 {
-00498         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00499 }
+Definition at line 534 of file modules.cpp.
00535 {
+00536         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00537 }
 

 

     
@@ -2494,16 +2583,16 @@ 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 518 of file modules.cpp.
00519 {
-00520         if (IncludeSender)
-00521         {
-00522                 WriteCommon(User,"%s",text.c_str());
-00523         }
-00524         else
-00525         {
-00526                 WriteCommonExcept(User,"%s",text.c_str());
-00527         }
-00528 }
+Definition at line 556 of file modules.cpp.
00557 {
+00558         if (IncludeSender)
+00559         {
+00560                 WriteCommon(User,"%s",text.c_str());
+00561         }
+00562         else
+00563         {
+00564                 WriteCommonExcept(User,"%s",text.c_str());
+00565         }
+00566 }
 

 

     
@@ -2553,9 +2642,9 @@ 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 477 of file modules.cpp.
00478 {
-00479         WriteFrom(Socket,User,"%s",s.c_str());
-00480 }
+Definition at line 515 of file modules.cpp.
00516 {
+00517         WriteFrom(Socket,User,"%s",s.c_str());
+00518 }
 

 

     
@@ -2612,11 +2701,11 @@ 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 462 of file modules.cpp.
+Definition at line 500 of file modules.cpp.
 

-References server_mode().
00463 {
-00464         server_mode(parameters,pcnt,user);
-00465 }
+References server_mode().
00501 {
+00502         server_mode(parameters,pcnt,user);
+00503 }
 

 

     
@@ -2651,9 +2740,9 @@ Sends text to all opers.
 

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

-Definition at line 392 of file modules.cpp.
00393 {
-00394         WriteOpers("%s",s.c_str());
-00395 }
+Definition at line 425 of file modules.cpp.
00426 {
+00427         WriteOpers("%s",s.c_str());
+00428 }
 

 

     
@@ -2697,9 +2786,9 @@ 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 472 of file modules.cpp.
00473 {
-00474         WriteServ(Socket,"%s",s.c_str());
-00475 }
+Definition at line 510 of file modules.cpp.
00511 {
+00512         WriteServ(Socket,"%s",s.c_str());
+00513 }
 

 

     
@@ -2753,20 +2842,20 @@ The format will become:

 :localserver TEXT

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

-Definition at line 482 of file modules.cpp.
-

-References connection::fd.
00483 {
-00484         if (!Source)
-00485         {
-00486                 // if source is NULL, then the message originates from the local server
-00487                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00488         }
-00489         else
-00490         {
-00491                 // otherwise it comes from the user specified
-00492                 WriteTo(Source,Dest,"%s",s.c_str());
-00493         }
-00494 }
+Definition at line 520 of file modules.cpp.
+

+References connection::fd.
00521 {
+00522         if (!Source)
+00523         {
+00524                 // if source is NULL, then the message originates from the local server
+00525                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00526         }
+00527         else
+00528         {
+00529                 // otherwise it comes from the user specified
+00530                 WriteTo(Source,Dest,"%s",s.c_str());
+00531         }
+00532 }
 

 

     
@@ -2818,9 +2907,9 @@ These can be RFC specified modes such as +i, or module provided modes, including
 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 405 of file modules.cpp.
00406 {
-00407         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00408 }
+Definition at line 438 of file modules.cpp.
00439 {
+00440         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00441 }
 

 

     
@@ -2864,9 +2953,9 @@ 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 530 of file modules.cpp.
00531 {
-00532         WriteWallOps(User,false,"%s",text.c_str());
-00533 }
+Definition at line 568 of file modules.cpp.
00569 {
+00570         WriteWallOps(User,false,"%s",text.c_str());
+00571 }
 

 

     
@@ -2910,37 +2999,37 @@ Remove a user's connection to the irc server, but leave their client in existenc
 

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

-References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
00640 {
-00641         unsigned int old_fd = user->fd;
-00642         user->fd = FD_MAGIC_NUMBER;
-00643         user->ClearBuffer();
-00644         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00645 #ifdef USE_KQUEUE
-00646         struct kevent ke;
-00647         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
-00648         int i = kevent(kq, &ke, 1, 0, 0, NULL);
-00649         if (i == -1)
-00650         {
-00651                 log(DEBUG,"kqueue: Failed to remove user from queue!");
-00652         }
-00653 #endif
-00654 #ifdef USE_EPOLL
-00655         struct epoll_event ev;
-00656         ev.events = EPOLLIN | EPOLLET;
-00657         ev.data.fd = old_fd;
-00658         int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev);
-00659         if (i < 0)
-00660         {
-00661                 log(DEBUG,"epoll: List deletion failure!");
-00662         }
-00663 #endif
-00664 
-00665         shutdown(old_fd,2);
-00666         close(old_fd);
-00667         return true;
-00668 }
+Definition at line 677 of file modules.cpp.
+

+References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
00678 {
+00679         unsigned int old_fd = user->fd;
+00680         user->fd = FD_MAGIC_NUMBER;
+00681         user->ClearBuffer();
+00682         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00683 #ifdef USE_KQUEUE
+00684         struct kevent ke;
+00685         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
+00686         int i = kevent(kq, &ke, 1, 0, 0, NULL);
+00687         if (i == -1)
+00688         {
+00689                 log(DEBUG,"kqueue: Failed to remove user from queue!");
+00690         }
+00691 #endif
+00692 #ifdef USE_EPOLL
+00693         struct epoll_event ev;
+00694         ev.events = EPOLLIN | EPOLLET;
+00695         ev.data.fd = old_fd;
+00696         int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev);
+00697         if (i < 0)
+00698         {
+00699                 log(DEBUG,"epoll: List deletion failure!");
+00700         }
+00701 #endif
+00702 
+00703         shutdown(old_fd,2);
+00704         close(old_fd);
+00705         return true;
+00706 }
 

 

     
@@ -2948,7 +3037,7 @@ References userrec::ClearBuff
+   + + +

+ +

+Definition at line 407 of file modules.cpp.

00408 {
+00409         WriteOpers("*** Rehashing config file");
+00410         ReadConfig(false,NULL);
+00411 }

The documentation for this class was generated from the following files: -
Generated on Sun Nov 27 01:43:26 2005 for InspIRCd by  +
Generated on Fri Dec 9 20:20:13 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91