From 2db0df5813e46fe5e077e014003acbd10698b913 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 20 Apr 2005 15:48:27 +0000 Subject: Added module message passing architecture git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1136 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 776 +++++++++++++++++++++------------------ 1 file changed, 413 insertions(+), 363 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 2d9666e44..f5a542c97 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -186,6 +186,9 @@ Inherits classbase. 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.

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. @@ -194,7 +197,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 505 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 627 of file modules.h.

Constructor & Destructor Documentation

@@ -224,10 +227,10 @@ Default constructor.

Creates a Server object.

-Definition at line 355 of file modules.cpp. +Definition at line 414 of file modules.cpp.

-

00356 {
-00357 }
+
00415 {
+00416 }
@@ -260,10 +263,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 359 of file modules.cpp. +Definition at line 418 of file modules.cpp.

-

00360 {
-00361 }
+
00419 {
+00420 }
 
    
   
 
@@ -327,13 +330,13 @@ 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 436 of file modules.cpp.
+Definition at line 495 of file modules.cpp.
 

 References createcommand().
 

-
00437 {
-00438         createcommand(cmd,f,flags,minparams,source);
-00439 }
+
00496 {
+00497         createcommand(cmd,f,flags,minparams,source);
+00498 }
 
    
   
 
@@ -388,13 +391,13 @@ 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 654 of file modules.cpp.
+Definition at line 713 of file modules.cpp.
 

 References add_eline(), and duration().
 

-
00655 {
-00656         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00657 }
+
00714 {
+00715         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00716 }
 
    
   
 
@@ -433,16 +436,16 @@ 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 581 of file modules.cpp.
+Definition at line 640 of file modules.cpp.
 

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

-
00582 {
-00583         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00584         if (res)
-00585                 ModeMakeList(modechar);
-00586         return res;
-00587 }
+
00641 {
+00642         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00643         if (res)
+00644                 ModeMakeList(modechar);
+00645         return res;
+00646 }
 
    
   
 
@@ -503,28 +506,28 @@ 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 561 of file modules.cpp.
-

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

-
00562 {
-00563         if (type == MT_SERVER)
-00564         {
-00565                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00566                 return false;
-00567         }
-00568         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00569         {
-00570                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00571                 return false;
-00572         }
-00573         if ((params_when_on>1) || (params_when_off>1))
-00574         {
-00575                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00576                 return false;
-00577         }
-00578         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00579 }
+Definition at line 620 of file modules.cpp.
+

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

+
00621 {
+00622         if (type == MT_SERVER)
+00623         {
+00624                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00625                 return false;
+00626         }
+00627         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00628         {
+00629                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00630                 return false;
+00631         }
+00632         if ((params_when_on>1) || (params_when_off>1))
+00633         {
+00634                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00635                 return false;
+00636         }
+00637         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00638 }
 
    
   
 
@@ -579,13 +582,13 @@ 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 634 of file modules.cpp.
+Definition at line 693 of file modules.cpp.
 

 References add_gline(), and duration().
 

-
00635 {
-00636         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00637 }
+
00694 {
+00695         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00696 }
 
    
   
 
@@ -640,13 +643,13 @@ 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 649 of file modules.cpp.
+Definition at line 708 of file modules.cpp.
 

 References add_kline(), and duration().
 

-
00650 {
-00651         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00652 }
+
00709 {
+00710         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00711 }
 
    
   
 
@@ -701,13 +704,13 @@ 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 639 of file modules.cpp.
+Definition at line 698 of file modules.cpp.
 

 References add_qline(), and duration().
 

-
00640 {
-00641         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00642 }
+
00699 {
+00700         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00701 }
 
    
   
 
@@ -762,13 +765,13 @@ 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 644 of file modules.cpp.
+Definition at line 703 of file modules.cpp.
 

 References add_zline(), and duration().
 

-
00645 {
-00646         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00647 }
+
00704 {
+00705         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00706 }
 
    
   
 
@@ -802,13 +805,13 @@ 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 684 of file modules.cpp.
+Definition at line 743 of file modules.cpp.
 

 References duration().
 

-
00685 {
-00686         return duration(delta.c_str());
-00687 }
+
00744 {
+00745         return duration(delta.c_str());
+00746 }
 
    
   
 
@@ -864,11 +867,11 @@ 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 426 of file modules.cpp.
+Definition at line 485 of file modules.cpp.
 

-
00427 {
-00428         call_handler(commandname.c_str(),parameters,pcnt,user);
-00429 }
+
00486 {
+00487         call_handler(commandname.c_str(),parameters,pcnt,user);
+00488 }
 
    
   
 
@@ -911,13 +914,13 @@ 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 514 of file modules.cpp.
+Definition at line 573 of file modules.cpp.
 

 References ChangeName().
 

-
00515 {
-00516         ChangeName(user,gecos.c_str());
-00517 }
+
00574 {
+00575         ChangeName(user,gecos.c_str());
+00576 }
 
    
   
 
@@ -960,13 +963,13 @@ 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 509 of file modules.cpp.
+Definition at line 568 of file modules.cpp.
 

 References ChangeDisplayedHost().
 

-
00510 {
-00511         ChangeDisplayedHost(user,host.c_str());
-00512 }
+
00569 {
+00570         ChangeDisplayedHost(user,host.c_str());
+00571 }
 
    
   
 
@@ -1009,11 +1012,11 @@ 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 410 of file modules.cpp.
+Definition at line 469 of file modules.cpp.
 

-
00411 {
-00412         force_nickchange(user,nickname.c_str());
-00413 }
+
00470 {
+00471         force_nickchange(user,nickname.c_str());
+00472 }
 
    
   
 
@@ -1056,13 +1059,13 @@ 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 534 of file modules.cpp.
+Definition at line 593 of file modules.cpp.
 

 References cmode().
 

-
00535 {
-00536         return cmode(User,Chan);
-00537 }
+
00594 {
+00595         return cmode(User,Chan);
+00596 }
 
    
   
 
@@ -1105,13 +1108,13 @@ 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 487 of file modules.cpp.
+Definition at line 546 of file modules.cpp.
 

 References common_channels().
 

-
00488 {
-00489         return (common_channels(u1,u2) != 0);
-00490 }
+
00547 {
+00548         return (common_channels(u1,u2) != 0);
+00549 }
 
    
   
 
@@ -1145,11 +1148,11 @@ 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 589 of file modules.cpp.
+Definition at line 648 of file modules.cpp.
 

-
00590 {
-00591         return usercount(c);
-00592 }
+
00649 {
+00650         return usercount(c);
+00651 }
 
    
   
 
@@ -1183,13 +1186,13 @@ Deletes a local E-Line.
 

 
 

-Definition at line 679 of file modules.cpp.
+Definition at line 738 of file modules.cpp.
 

 References del_eline().
 

-
00680 {
-00681         del_eline(hostmask.c_str());
-00682 }
+
00739 {
+00740         del_eline(hostmask.c_str());
+00741 }
 
    
   
 
@@ -1223,13 +1226,13 @@ Deletes a G-Line from all servers on the mesh.
 

 
 

-Definition at line 659 of file modules.cpp.
+Definition at line 718 of file modules.cpp.
 

 References del_gline().
 

-
00660 {
-00661         del_gline(hostmask.c_str());
-00662 }
+
00719 {
+00720         del_gline(hostmask.c_str());
+00721 }
 
    
   
 
@@ -1263,13 +1266,13 @@ Deletes a local K-Line.
 

 
 

-Definition at line 674 of file modules.cpp.
+Definition at line 733 of file modules.cpp.
 

 References del_kline().
 

-
00675 {
-00676         del_kline(hostmask.c_str());
-00677 }
+
00734 {
+00735         del_kline(hostmask.c_str());
+00736 }
 
    
   
 
@@ -1303,13 +1306,13 @@ Deletes a Q-Line from all servers on the mesh.
 

 
 

-Definition at line 664 of file modules.cpp.
+Definition at line 723 of file modules.cpp.
 

 References del_qline().
 

-
00665 {
-00666         del_qline(nickname.c_str());
-00667 }
+
00724 {
+00725         del_qline(nickname.c_str());
+00726 }
 
    
   
 
@@ -1343,13 +1346,13 @@ Deletes a Z-Line from all servers on the mesh.
 

 
 

-Definition at line 669 of file modules.cpp.
+Definition at line 728 of file modules.cpp.
 

 References del_zline().
 

-
00670 {
-00671         del_zline(ipaddr.c_str());
-00672 }
+
00729 {
+00730         del_zline(ipaddr.c_str());
+00731 }
 
    
   
 
@@ -1383,11 +1386,58 @@ 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 529 of file modules.cpp.
+Definition at line 588 of file modules.cpp.
 

-
00530 {
-00531         return FindChan(channel.c_str());
-00532 }
+
00589 {
+00590         return FindChan(channel.c_str());
+00591 }
+
    
+  
+
+

+
+  
+    
+  
+

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

+    

+
+  
+    
+    

+       
+    
+
+

+This function finds a module by name. 
+

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

+Definition at line 821 of file modules.cpp.
+

+References MODCOUNT, module_names, and modules.
+

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

 

@@ -1421,11 +1471,11 @@ 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 524 of file modules.cpp.
+Definition at line 583 of file modules.cpp.
 

-
00525 {
-00526         return Find(nick);
-00527 }
+
00584 {
+00585         return Find(nick);
+00586 }
 
    
   
 
@@ -1458,11 +1508,11 @@ 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 554 of file modules.cpp.
+Definition at line 613 of file modules.cpp.
 

-
00555 {
-00556         return Admin(getadminname(),getadminemail(),getadminnick());
-00557 }
+
00614 {
+00615         return Admin(getadminname(),getadminemail(),getadminnick());
+00616 }
 
    
   
 
@@ -1495,11 +1545,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 549 of file modules.cpp.
+Definition at line 608 of file modules.cpp.
 

-
00550 {
-00551         return getnetworkname();
-00552 }
+
00609 {
+00610         return getnetworkname();
+00611 }
 
    
   
 
@@ -1532,11 +1582,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 544 of file modules.cpp.
+Definition at line 603 of file modules.cpp.
 

-
00545 {
-00546         return getservername();
-00547 }
+
00604 {
+00605         return getservername();
+00606 }
 
    
   
 
@@ -1570,28 +1620,28 @@ 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.
-

-References chanuserlist, clientlist, has_channel(), and isnick().
-

-
00392 {
-00393         chanuserlist userl;
-00394         userl.clear();
-00395         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00396         {
-00397                 if (i->second)
-00398                 {
-00399                         if (has_channel(i->second,chan))
-00400                         {
-00401                                 if (isnick(i->second->nick))
-00402                                 {
-00403                                         userl.push_back(i->second);
-00404                                 }
-00405                         }
-00406                 }
-00407         }
-00408         return userl;
-00409 }
+Definition at line 450 of file modules.cpp.
+

+References chanuserlist, clientlist, has_channel(), and isnick().
+

+
00451 {
+00452         chanuserlist userl;
+00453         userl.clear();
+00454         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00455         {
+00456                 if (i->second)
+00457                 {
+00458                         if (has_channel(i->second,chan))
+00459                         {
+00460                                 if (isnick(i->second->nick))
+00461                                 {
+00462                                         userl.push_back(i->second);
+00463                                 }
+00464                         }
+00465                 }
+00466         }
+00467         return userl;
+00468 }
 
    
   
 
@@ -1625,13 +1675,13 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 519 of file modules.cpp.
+Definition at line 578 of file modules.cpp.
 

 References isnick().
 

-
00520 {
-00521         return (isnick(nick.c_str()) != 0);
-00522 }
+
00579 {
+00580         return (isnick(nick.c_str()) != 0);
+00581 }
 
    
   
 
@@ -1674,13 +1724,13 @@ 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 539 of file modules.cpp.
+Definition at line 598 of file modules.cpp.
 

 References has_channel().
 

-
00540 {
-00541         return has_channel(User,Chan);
-00542 }
+
00599 {
+00600         return has_channel(User,Chan);
+00601 }
 
    
   
 
@@ -1714,13 +1764,13 @@ 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 421 of file modules.cpp.
+Definition at line 480 of file modules.cpp.
 

 References is_uline().
 

-
00422 {
-00423         return is_uline(server.c_str());
-00424 }
+
00481 {
+00482         return is_uline(server.c_str());
+00483 }
 
    
   
 
@@ -1754,35 +1804,35 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
 

 
 

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

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

+
00749 {
+00750         const char* dest = mask.c_str();
+00751         if (strchr(dest,'!')==0)
+00752                 return false;
+00753         if (strchr(dest,'@')==0)
+00754                 return false;
+00755         for (int i = 0; i < strlen(dest); i++)
+00756                 if (dest[i] < 32)
+00757                         return false;
+00758         for (int i = 0; i < strlen(dest); i++)
+00759                 if (dest[i] > 126)
+00760                         return false;
+00761         int c = 0;
+00762         for (int i = 0; i < strlen(dest); i++)
+00763                 if (dest[i] == '!')
+00764                         c++;
+00765         if (c>1)
+00766                 return false;
+00767         c = 0;
+00768         for (int i = 0; i < strlen(dest); i++)
+00769                 if (dest[i] == '@')
+00770                         c++;
+00771         if (c>1)
+00772                 return false;
+00773 
+00774         return true;
+00775 }
 
    
   
 
@@ -1831,11 +1881,11 @@ 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.
+Definition at line 440 of file modules.cpp.
 

-
00382 {
-00383         return add_channel(user,cname.c_str(),key.c_str(),true);
-00384 }
+
00441 {
+00442         return add_channel(user,cname.c_str(),key.c_str(),true);
+00443 }
 
    
   
 
@@ -1878,11 +1928,11 @@ 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 431 of file modules.cpp.
+Definition at line 490 of file modules.cpp.
 

-
00432 {
-00433         log(level,"%s",s.c_str());
-00434 }
+
00491 {
+00492         log(level,"%s",s.c_str());
+00493 }
 
    
   
 
@@ -1925,14 +1975,14 @@ 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.
+Definition at line 427 of file modules.cpp.
 

-
00369 {
-00370         char literal[MAXBUF],pattern[MAXBUF];
-00371         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00372         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00373         return match(literal,pattern);
-00374 }
+
00428 {
+00429         char literal[MAXBUF],pattern[MAXBUF];
+00430         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00431         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00432         return match(literal,pattern);
+00433 }
 
    
   
 
@@ -1975,15 +2025,15 @@ This function is used to check if any users on channel c are on server servernam
 

 This is used internally by PRIVMSG etc. You should not need to use it.
 

-Definition at line 744 of file modules.cpp.
+Definition at line 803 of file modules.cpp.
 

-
00745 {
-00746         if (c)
-00747         {
-00748                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-00749         }
-00750         else return false;
-00751 }
+
00804 {
+00805         if (c)
+00806         {
+00807                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+00808         }
+00809         else return false;
+00810 }
 
    
   
 
@@ -2026,15 +2076,15 @@ This function is used to check if user u has any channels in common with users o
 

 This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
 

-Definition at line 753 of file modules.cpp.
+Definition at line 812 of file modules.cpp.
 

-
00754 {
-00755         if (u)
-00756         {
-00757                 return CommonOnThisServer(u,(char*)servername.c_str());
-00758         }
-00759         else return false;
-00760 }
+
00813 {
+00814         if (u)
+00815         {
+00816                 return CommonOnThisServer(u,(char*)servername.c_str());
+00817         }
+00818         else return false;
+00819 }
 
    
   
 
@@ -2068,11 +2118,11 @@ 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 718 of file modules.cpp.
+Definition at line 777 of file modules.cpp.
 

-
00719 {
-00720         NetSendToAll((char*)text.c_str());
-00721 }
+
00778 {
+00779         NetSendToAll((char*)text.c_str());
+00780 }
 
    
   
 
@@ -2106,11 +2156,11 @@ This function is equivalent to Server::MeshSendToAll except it will only route t
 

 
 

-Definition at line 729 of file modules.cpp.
+Definition at line 788 of file modules.cpp.
 

-
00730 {
-00731         NetSendToAllAlive((char*)text.c_str());
-00732 }
+
00789 {
+00790         NetSendToAllAlive((char*)text.c_str());
+00791 }
 
    
   
 
@@ -2153,11 +2203,11 @@ 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 739 of file modules.cpp.
+Definition at line 798 of file modules.cpp.
 

-
00740 {
-00741         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-00742 }
+
00799 {
+00800         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+00801 }
 
    
   
 
@@ -2200,12 +2250,12 @@ This method sends a line of text to all servers who have users which share commo
 

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

-
00724 {
-00725         if (user)
-00726                 NetSendToCommon(user,(char*)text.c_str());
-00727 }
+
00783 {
+00784         if (user)
+00785                 NetSendToCommon(user,(char*)text.c_str());
+00786 }
 
    
   
 
@@ -2248,11 +2298,11 @@ 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 734 of file modules.cpp.
+Definition at line 793 of file modules.cpp.
 

-
00735 {
-00736         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-00737 }
+
00794 {
+00795         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+00796 }
 
    
   
 
@@ -2301,11 +2351,11 @@ 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.
+Definition at line 445 of file modules.cpp.
 

-
00387 {
-00388         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00389 }
+
00446 {
+00447         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00448 }
 
    
   
 
@@ -2354,38 +2404,38 @@ 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 604 of file modules.cpp.
-

-References ucrec::channel, userrec::chans, chanrec::created, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
-

-
00605 {
-00606         zombie->fd = alive->fd;
-00607         alive->fd = FD_MAGIC_NUMBER;
-00608         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00609         kill_link(alive,message.c_str());
-00610         for (int i = 0; i != MAXCHANS; i++)
-00611         {
-00612                 if (zombie->chans[i].channel != NULL)
-00613                 {
-00614                         if (zombie->chans[i].channel->name)
-00615                         {
-00616                                 chanrec* Ptr = zombie->chans[i].channel;
-00617                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00618                                 if (Ptr->topicset)
-00619                                 {
-00620                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00621                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00622                                 }
-00623                                 userlist(zombie,Ptr);
-00624                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00625                                 WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
-00626                                 WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
-00627 
-00628                         }
-00629                 }
-00630         }
-00631 
-00632 }
+Definition at line 663 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.
+

+
00664 {
+00665         zombie->fd = alive->fd;
+00666         alive->fd = FD_MAGIC_NUMBER;
+00667         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00668         kill_link(alive,message.c_str());
+00669         for (int i = 0; i != MAXCHANS; i++)
+00670         {
+00671                 if (zombie->chans[i].channel != NULL)
+00672                 {
+00673                         if (zombie->chans[i].channel->name)
+00674                         {
+00675                                 chanrec* Ptr = zombie->chans[i].channel;
+00676                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00677                                 if (Ptr->topicset)
+00678                                 {
+00679                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00680                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00681                                 }
+00682                                 userlist(zombie,Ptr);
+00683                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00684                                 //WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
+00685                                 //WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
+00686 
+00687                         }
+00688                 }
+00689         }
+00690 
+00691 }
 
    
   
 
@@ -2430,14 +2480,14 @@ 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 415 of file modules.cpp.
+Definition at line 474 of file modules.cpp.
 

 References userrec::nick, and send_network_quit().
 

-
00416 {
-00417         send_network_quit(user->nick,reason.c_str());
-00418         kill_link(user,reason.c_str());
-00419 }
+
00475 {
+00476         send_network_quit(user->nick,reason.c_str());
+00477         kill_link(user,reason.c_str());
+00478 }
 
    
   
 
@@ -2480,11 +2530,11 @@ 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 446 of file modules.cpp.
+Definition at line 505 of file modules.cpp.
 

-
00447 {
-00448         Write(Socket,"%s",s.c_str());
-00449 }
+
00506 {
+00507         Write(Socket,"%s",s.c_str());
+00508 }
 
    
   
 
@@ -2539,18 +2589,18 @@ 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 475 of file modules.cpp.
-

-
00476 {
-00477         if (IncludeSender)
-00478         {
-00479                 WriteChannel(Channel,User,"%s",s.c_str());
-00480         }
-00481         else
-00482         {
-00483                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00484         }
-00485 }
+Definition at line 534 of file modules.cpp.
+

+
00535 {
+00536         if (IncludeSender)
+00537         {
+00538                 WriteChannel(Channel,User,"%s",s.c_str());
+00539         }
+00540         else
+00541         {
+00542                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00543         }
+00544 }
 
    
   
 
@@ -2599,18 +2649,18 @@ 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 492 of file modules.cpp.
-

-
00493 {
-00494         if (IncludeSender)
-00495         {
-00496                 WriteCommon(User,"%s",text.c_str());
-00497         }
-00498         else
-00499         {
-00500                 WriteCommonExcept(User,"%s",text.c_str());
-00501         }
-00502 }
+Definition at line 551 of file modules.cpp.
+

+
00552 {
+00553         if (IncludeSender)
+00554         {
+00555                 WriteCommon(User,"%s",text.c_str());
+00556         }
+00557         else
+00558         {
+00559                 WriteCommonExcept(User,"%s",text.c_str());
+00560         }
+00561 }
 
    
   
 
@@ -2659,11 +2709,11 @@ 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 456 of file modules.cpp.
+Definition at line 515 of file modules.cpp.
 

-
00457 {
-00458         WriteFrom(Socket,User,"%s",s.c_str());
-00459 }
+
00516 {
+00517         WriteFrom(Socket,User,"%s",s.c_str());
+00518 }
 
    
   
 
@@ -2719,13 +2769,13 @@ 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 441 of file modules.cpp.
+Definition at line 500 of file modules.cpp.
 

 References server_mode().
 

-
00442 {
-00443         server_mode(parameters,pcnt,user);
-00444 }
+
00501 {
+00502         server_mode(parameters,pcnt,user);
+00503 }
 
    
   
 
@@ -2759,11 +2809,11 @@ 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.
+Definition at line 422 of file modules.cpp.
 

-
00364 {
-00365         WriteOpers("%s",s.c_str());
-00366 }
+
00423 {
+00424         WriteOpers("%s",s.c_str());
+00425 }
 
    
   
 
@@ -2806,11 +2856,11 @@ 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 451 of file modules.cpp.
+Definition at line 510 of file modules.cpp.
 

-
00452 {
-00453         WriteServ(Socket,"%s",s.c_str());
-00454 }
+
00511 {
+00512         WriteServ(Socket,"%s",s.c_str());
+00513 }
 
    
   
 
@@ -2863,22 +2913,22 @@ The format will become:

 :localserver TEXT

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

-Definition at line 461 of file modules.cpp.
+Definition at line 520 of file modules.cpp.
 

 References connection::fd.
 

-
00462 {
-00463         if (!Source)
-00464         {
-00465                 // if source is NULL, then the message originates from the local server
-00466                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00467         }
-00468         else
-00469         {
-00470                 // otherwise it comes from the user specified
-00471                 WriteTo(Source,Dest,"%s",s.c_str());
-00472         }
-00473 }
+
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 }
 
    
   
 
@@ -2929,11 +2979,11 @@ 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 376 of file modules.cpp.
+Definition at line 435 of file modules.cpp.
 

-
00377 {
-00378         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00379 }
+
00436 {
+00437         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00438 }
 
    
   
 
@@ -2976,11 +3026,11 @@ 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 504 of file modules.cpp.
+Definition at line 563 of file modules.cpp.
 

-
00505 {
-00506         WriteWallOps(User,false,"%s",text.c_str());
-00507 }
+
00564 {
+00565         WriteWallOps(User,false,"%s",text.c_str());
+00566 }
 
    
   
 
@@ -3023,23 +3073,23 @@ 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 595 of file modules.cpp.
+Definition at line 654 of file modules.cpp.
 

 References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
 

-
00596 {
-00597         unsigned int old_fd = user->fd;
-00598         user->fd = FD_MAGIC_NUMBER;
-00599         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00600         close(old_fd);
-00601         shutdown (old_fd,2);
-00602 }
+
00655 {
+00656         unsigned int old_fd = user->fd;
+00657         user->fd = FD_MAGIC_NUMBER;
+00658         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00659         close(old_fd);
+00660         shutdown (old_fd,2);
+00661 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sat Apr 16 18:57:22 2005 for InspIRCd by
+
Generated on Wed Apr 20 15:47:11 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3