From 1d994c544474da53159257d9097997c0744a48a5 Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 6 Apr 2004 10:43:34 +0000 Subject: Added support for SVS-style Server class methods for modules git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@400 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 491 +++++++++++++++++++++++++++++---------- 1 file changed, 372 insertions(+), 119 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index b6c3a546f..427f273cf 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -66,6 +66,16 @@ Inheritance diagram for Server:



virtual void SendMode (char **parameters, int pcnt, userrec *user)  Sends a servermode.

+virtual void SendToModeMask (std::string modes, int flags, std::string text) + Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

+virtual chanrec * Server::JoinUserToChannel (userrec *user, std::string cname, std::string key) + Forces a user to join a channel.

+virtual chanrec * Server::PartUserFromChannel (userrec *user, std::string cname, std::string reason) + Forces a user to part a channel.

+virtual void ChangeUserNick (userrec *user, std::string nickname) + Forces a user nickchange.

+virtual void QuitUser (userrec *user, std::string reason) + Forces a user to quit with the specified reason.

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

-Definition at line 197 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 219 of file modules.h.

Constructor & Destructor Documentation

@@ -104,10 +114,10 @@ Default constructor.

Creates a Server object.

-Definition at line 125 of file modules.cpp. +Definition at line 128 of file modules.cpp.

-

00126 {
-00127 }
+
00129 {
+00130 }
@@ -140,10 +150,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 129 of file modules.cpp. +Definition at line 132 of file modules.cpp.

-

00130 {
-00131 }
+
00133 {
+00134 }
 
    
   
 
@@ -201,13 +211,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'.
 

-Definition at line 143 of file modules.cpp.
+Definition at line 172 of file modules.cpp.
 

 References createcommand().
 

-
00144 {
-00145         createcommand(cmd,f,flags,minparams);
-00146 }
+
00173 {
+00174         createcommand(cmd,f,flags,minparams);
+00175 }
 
    
   
 
@@ -268,28 +278,75 @@ Adds an extended mode letter which is parsed by a module This allows modules to
 

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

 References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 

-
00245 {
-00246         if (type == MT_SERVER)
-00247         {
-00248                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00249                 return false;
-00250         }
-00251         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00252         {
-00253                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00254                 return false;
-00255         }
-00256         if ((params_when_on>1) || (params_when_off>1))
-00257         {
-00258                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00259                 return false;
-00260         }
-00261         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00262 }
+
00274 {
+00275         if (type == MT_SERVER)
+00276         {
+00277                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00278                 return false;
+00279         }
+00280         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00281         {
+00282                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00283                 return false;
+00284         }
+00285         if ((params_when_on>1) || (params_when_off>1))
+00286         {
+00287                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00288                 return false;
+00289         }
+00290         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00291 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::ChangeUserNick ( userrec *   user, 
std::string   nickname
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

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

+
00157 {
+00158         force_nickchange(user,nickname.c_str());
+00159 }
 
    		
   

 

@@ -332,11 +389,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 222 of file modules.cpp.
+Definition at line 251 of file modules.cpp.
 

-
00223 {
-00224         return cmode(User,Chan);
-00225 }
+
00252 {
+00253         return cmode(User,Chan);
+00254 }
 
    
   
 
@@ -379,11 +436,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 185 of file modules.cpp.
+Definition at line 214 of file modules.cpp.
 

-
00186 {
-00187         return (common_channels(u1,u2) != 0);
-00188 }
+
00215 {
+00216         return (common_channels(u1,u2) != 0);
+00217 }
 
    
   
 
@@ -417,11 +474,11 @@ 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 217 of file modules.cpp.
+Definition at line 246 of file modules.cpp.
 

-
00218 {
-00219         return FindChan(channel.c_str());
-00220 }
+
00247 {
+00248         return FindChan(channel.c_str());
+00249 }
 
    
   
 
@@ -455,11 +512,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 212 of file modules.cpp.
+Definition at line 241 of file modules.cpp.
 

-
00213 {
-00214         return Find(nick);
-00215 }
+
00242 {
+00243         return Find(nick);
+00244 }
 
    
   
 
@@ -492,11 +549,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 237 of file modules.cpp.
+Definition at line 266 of file modules.cpp.
 

-
00238 {
-00239         return Admin(getadminname(),getadminemail(),getadminnick());
-00240 }
+
00267 {
+00268         return Admin(getadminname(),getadminemail(),getadminnick());
+00269 }
 
    
   
 
@@ -529,11 +586,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 232 of file modules.cpp.
+Definition at line 261 of file modules.cpp.
 

-
00233 {
-00234         return getnetworkname();
-00235 }
+
00262 {
+00263         return getnetworkname();
+00264 }
 
    
   
 
@@ -566,11 +623,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 227 of file modules.cpp.
+Definition at line 256 of file modules.cpp.
 

-
00228 {
-00229         return getservername();
-00230 }
+
00257 {
+00258         return getservername();
+00259 }
 
    
   
 
@@ -604,11 +661,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 207 of file modules.cpp.
+Definition at line 236 of file modules.cpp.
 

-
00208 {
-00209         return (isnick(nick.c_str()) != 0);
-00210 }
+
00237 {
+00238         return (isnick(nick.c_str()) != 0);
+00239 }
 
    
   
 
@@ -651,11 +708,60 @@ 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 138 of file modules.cpp.
+Definition at line 167 of file modules.cpp.
+

+
00168 {
+00169         log(level,"%s",s.c_str());
+00170 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::QuitUser ( userrec *   user, 
std::string   reason
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

+Forces a user to quit with the specified reason.
+

+To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.

+WARNING!

+Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.
+

+Definition at line 161 of file modules.cpp.
 

-
00139 {
-00140         log(level,"%s",s.c_str());
-00141 }
+
00162 {
+00163         kill_link(user,reason.c_str());
+00164 }
 
    

   

 

@@ -698,11 +804,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 153 of file modules.cpp.
+Definition at line 182 of file modules.cpp.
 

-
00154 {
-00155         Write(Socket,"%s",s.c_str());
-00156 }
+
00183 {
+00184         Write(Socket,"%s",s.c_str());
+00185 }
 
    
   
 
@@ -757,18 +863,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 173 of file modules.cpp.
-

-
00174 {
-00175         if (IncludeSender)
-00176         {
-00177                 WriteChannel(Channel,User,"%s",s.c_str());
-00178         }
-00179         else
-00180         {
-00181                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00182         }
-00183 }
+Definition at line 202 of file modules.cpp.
+

+
00203 {
+00204         if (IncludeSender)
+00205         {
+00206                 WriteChannel(Channel,User,"%s",s.c_str());
+00207         }
+00208         else
+00209         {
+00210                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00211         }
+00212 }
 
    
   
 
@@ -817,18 +923,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 190 of file modules.cpp.
-

-
00191 {
-00192         if (IncludeSender)
-00193         {
-00194                 WriteCommon(User,"%s",text.c_str());
-00195         }
-00196         else
-00197         {
-00198                 WriteCommonExcept(User,"%s",text.c_str());
-00199         }
-00200 }
+Definition at line 219 of file modules.cpp.
+

+
00220 {
+00221         if (IncludeSender)
+00222         {
+00223                 WriteCommon(User,"%s",text.c_str());
+00224         }
+00225         else
+00226         {
+00227                 WriteCommonExcept(User,"%s",text.c_str());
+00228         }
+00229 }
 
    
   
 
@@ -877,11 +983,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 163 of file modules.cpp.
+Definition at line 192 of file modules.cpp.
 

-
00164 {
-00165         WriteFrom(Socket,User,"%s",s.c_str());
-00166 }
+
00193 {
+00194         WriteFrom(Socket,User,"%s",s.c_str());
+00195 }
 
    
   
 
@@ -937,13 +1043,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 148 of file modules.cpp.
+Definition at line 177 of file modules.cpp.
 

 References server_mode().
 

-
00149 {
-00150         server_mode(parameters,pcnt,user);
-00151 }
+
00178 {
+00179         server_mode(parameters,pcnt,user);
+00180 }
 
    
   
 
@@ -977,11 +1083,11 @@ Sends text to all opers.
 

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

-Definition at line 133 of file modules.cpp.
+Definition at line 136 of file modules.cpp.
 

-
00134 {
-00135         WriteOpers("%s",s.c_str());
-00136 }
+
00137 {
+00138         WriteOpers("%s",s.c_str());
+00139 }
 
    
   
 
@@ -1024,11 +1130,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 158 of file modules.cpp.
+Definition at line 187 of file modules.cpp.
 

-
00159 {
-00160         WriteServ(Socket,"%s",s.c_str());
-00161 }
+
00188 {
+00189         WriteServ(Socket,"%s",s.c_str());
+00190 }
 
    
   
 
@@ -1077,11 +1183,66 @@ Sends text from a user to another user.
 

 This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
 

-Definition at line 168 of file modules.cpp.
+Definition at line 197 of file modules.cpp.
 

-
00169 {
-00170         WriteTo(Source,Dest,"%s",s.c_str());
-00171 }
+
00198 {
+00199         WriteTo(Source,Dest,"%s",s.c_str());
+00200 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::SendToModeMask ( std::string   modes, 
int   flags, 
std::string   text
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

+Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.
+

+These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:

+Serv->SendToModeMask("xi", WM_OR, "m00");

+Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.
+

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

+
00142 {
+00143         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00144 }
 
    		
   

 

@@ -1124,17 +1285,109 @@ 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 202 of file modules.cpp.
+Definition at line 231 of file modules.cpp.
 

-
00203 {
-00204         WriteWallOps(User,"%s",text.c_str());
-00205 }
+
00232 {
+00233         WriteWallOps(User,"%s",text.c_str());
+00234 }
 
    
   
 
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 virtual chanrec* Server::Server::JoinUserToChannel ( userrec *   user, 
std::string   cname, 
std::string   key
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+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.    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 virtual chanrec* Server::Server::PartUserFromChannel ( userrec *   user, 
std::string   cname, 
std::string   reason
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+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.    

 
The documentation for this class was generated from the following files:
-
Generated on Mon Apr 5 02:04:09 2004 for InspIRCd by
+
Generated on Tue Apr 6 11:42:46 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3