From b25c31de6b8dd839429cb168f5731a5605e17366 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 24 Apr 2004 23:26:47 +0000 Subject: Added new documentation for XLine etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@718 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 412 ++++++++++++++++++++++----------------- 1 file changed, 232 insertions(+), 180 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 73835e18e..b0f90ba36 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -86,6 +86,8 @@ Inheritance diagram for Server:



virtual void ChangeGECOS (userrec *user, std::string gecos)  Change GECOS (fullname) of a user.

+virtual bool IsUlined (std::string server) + Returns true if the servername you give is ulined.

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

-Definition at line 241 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 250 of file modules.h.

Constructor & Destructor Documentation

@@ -124,10 +126,10 @@ Default constructor.

Creates a Server object.

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

-

00134 {
-00135 }
+
00136 {
+00137 }
@@ -160,10 +162,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 137 of file modules.cpp. +Definition at line 139 of file modules.cpp.

-

00138 {
-00139 }
+
00140 {
+00141 }
 
    
   
 
@@ -218,16 +220,16 @@ Definition at line 137
 Adds a command to the command table.
 

 This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:

-typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

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

 References createcommand().
 

-
00191 {
-00192         createcommand(cmd,f,flags,minparams);
-00193 }
+
00198 {
+00199         createcommand(cmd,f,flags,minparams);
+00200 }
 
    
   
 
@@ -288,28 +290,28 @@ 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 310 of file modules.cpp.
-

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

-
00311 {
-00312         if (type == MT_SERVER)
-00313         {
-00314                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00315                 return false;
-00316         }
-00317         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00318         {
-00319                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00320                 return false;
-00321         }
-00322         if ((params_when_on>1) || (params_when_off>1))
-00323         {
-00324                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00325                 return false;
-00326         }
-00327         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00328 }
+Definition at line 317 of file modules.cpp.
+

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

+
00318 {
+00319         if (type == MT_SERVER)
+00320         {
+00321                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00322                 return false;
+00323         }
+00324         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00325         {
+00326                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00327                 return false;
+00328         }
+00329         if ((params_when_on>1) || (params_when_off>1))
+00330         {
+00331                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00332                 return false;
+00333         }
+00334         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00335 }
 
    
   
 
@@ -365,11 +367,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 180 of file modules.cpp.
+Definition at line 187 of file modules.cpp.
 

-
00181 {
-00182         call_handler(commandname.c_str(),parameters,pcnt,user);
-00183 }
+
00188 {
+00189         call_handler(commandname.c_str(),parameters,pcnt,user);
+00190 }
 
    
   
 
@@ -412,11 +414,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 268 of file modules.cpp.
+Definition at line 275 of file modules.cpp.
+

+References ChangeName().
 

-
00269 {
-00270         ChangeName(user,gecos.c_str());
-00271 }
+
00276 {
+00277         ChangeName(user,gecos.c_str());
+00278 }
 
    
   
 
@@ -459,11 +463,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 263 of file modules.cpp.
+Definition at line 270 of file modules.cpp.
+

+References ChangeDisplayedHost().
 

-
00264 {
-00265         ChangeDisplayedHost(user,host.c_str());
-00266 }
+
00271 {
+00272         ChangeDisplayedHost(user,host.c_str());
+00273 }
 
    
   
 
@@ -506,11 +512,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 169 of file modules.cpp.
+Definition at line 171 of file modules.cpp.
 

-
00170 {
-00171         force_nickchange(user,nickname.c_str());
-00172 }
+
00172 {
+00173         force_nickchange(user,nickname.c_str());
+00174 }
 
    
   
 
@@ -553,11 +559,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 288 of file modules.cpp.
+Definition at line 295 of file modules.cpp.
 

-
00289 {
-00290         return cmode(User,Chan);
-00291 }
+References cmode().
+

+
00296 {
+00297         return cmode(User,Chan);
+00298 }
 
    
   
 
@@ -600,11 +608,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 241 of file modules.cpp.
+Definition at line 248 of file modules.cpp.
+

+References common_channels().
 

-
00242 {
-00243         return (common_channels(u1,u2) != 0);
-00244 }
+
00249 {
+00250         return (common_channels(u1,u2) != 0);
+00251 }
 
    
   
 
@@ -638,11 +648,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 330 of file modules.cpp.
+Definition at line 337 of file modules.cpp.
 

-
00331 {
-00332         return usercount(c);
-00333 }
+
00338 {
+00339         return usercount(c);
+00340 }
 
    
   
 
@@ -676,11 +686,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 283 of file modules.cpp.
+Definition at line 290 of file modules.cpp.
 

-
00284 {
-00285         return FindChan(channel.c_str());
-00286 }
+
00291 {
+00292         return FindChan(channel.c_str());
+00293 }
 
    
   
 
@@ -714,11 +724,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 278 of file modules.cpp.
+Definition at line 285 of file modules.cpp.
 

-
00279 {
-00280         return Find(nick);
-00281 }
+
00286 {
+00287         return Find(nick);
+00288 }
 
    
   
 
@@ -751,11 +761,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 303 of file modules.cpp.
+Definition at line 310 of file modules.cpp.
 

-
00304 {
-00305         return Admin(getadminname(),getadminemail(),getadminnick());
-00306 }
+
00311 {
+00312         return Admin(getadminname(),getadminemail(),getadminnick());
+00313 }
 
    
   
 
@@ -788,11 +798,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 298 of file modules.cpp.
+Definition at line 305 of file modules.cpp.
 

-
00299 {
-00300         return getnetworkname();
-00301 }
+
00306 {
+00307         return getnetworkname();
+00308 }
 
    
   
 
@@ -825,11 +835,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 293 of file modules.cpp.
+Definition at line 300 of file modules.cpp.
 

-
00294 {
-00295         return getservername();
-00296 }
+
00301 {
+00302         return getservername();
+00303 }
 
    
   
 
@@ -863,11 +873,53 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 273 of file modules.cpp.
+Definition at line 280 of file modules.cpp.
+

+References isnick().
+

+
00281 {
+00282         return (isnick(nick.c_str()) != 0);
+00283 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+
+      
 bool Server::IsUlined ( std::string   server          )  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

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

+References is_uline().
 

-
00274 {
-00275         return (isnick(nick.c_str()) != 0);
-00276 }
+
00183 {
+00184         return is_uline(server.c_str());
+00185 }
 
    

   

 

@@ -916,11 +968,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 159 of file modules.cpp.
+Definition at line 161 of file modules.cpp.
 

-
00160 {
-00161         return add_channel(user,cname.c_str(),key.c_str(),true);
-00162 }
+
00162 {
+00163         return add_channel(user,cname.c_str(),key.c_str(),true);
+00164 }
 
    
   
 
@@ -963,11 +1015,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 185 of file modules.cpp.
+Definition at line 192 of file modules.cpp.
 

-
00186 {
-00187         log(level,"%s",s.c_str());
-00188 }
+
00193 {
+00194         log(level,"%s",s.c_str());
+00195 }
 
    
   
 
@@ -1010,14 +1062,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 146 of file modules.cpp.
+Definition at line 148 of file modules.cpp.
 

-
00147 {
-00148         char literal[MAXBUF],pattern[MAXBUF];
-00149         strncpy(literal,sliteral.c_str(),MAXBUF);
-00150         strncpy(pattern,spattern.c_str(),MAXBUF);
-00151         return match(literal,pattern);
-00152 }
+
00149 {
+00150         char literal[MAXBUF],pattern[MAXBUF];
+00151         strncpy(literal,sliteral.c_str(),MAXBUF);
+00152         strncpy(pattern,spattern.c_str(),MAXBUF);
+00153         return match(literal,pattern);
+00154 }
 
    
   
 
@@ -1066,11 +1118,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 164 of file modules.cpp.
+Definition at line 166 of file modules.cpp.
 

-
00165 {
-00166         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00167 }
+
00167 {
+00168         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00169 }
 
    
   
 
@@ -1115,14 +1167,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 174 of file modules.cpp.
+Definition at line 176 of file modules.cpp.
 

-References userrec::nick.
+References userrec::nick, and send_network_quit().
 

-
00175 {
-00176         send_network_quit(user->nick,reason.c_str());
-00177         kill_link(user,reason.c_str());
-00178 }
+
00177 {
+00178         send_network_quit(user->nick,reason.c_str());
+00179         kill_link(user,reason.c_str());
+00180 }
 
    
   
 
@@ -1165,11 +1217,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 200 of file modules.cpp.
+Definition at line 207 of file modules.cpp.
 

-
00201 {
-00202         Write(Socket,"%s",s.c_str());
-00203 }
+
00208 {
+00209         Write(Socket,"%s",s.c_str());
+00210 }
 
    
   
 
@@ -1224,18 +1276,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 229 of file modules.cpp.
-

-
00230 {
-00231         if (IncludeSender)
-00232         {
-00233                 WriteChannel(Channel,User,"%s",s.c_str());
-00234         }
-00235         else
-00236         {
-00237                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00238         }
-00239 }
+Definition at line 236 of file modules.cpp.
+

+
00237 {
+00238         if (IncludeSender)
+00239         {
+00240                 WriteChannel(Channel,User,"%s",s.c_str());
+00241         }
+00242         else
+00243         {
+00244                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00245         }
+00246 }
 
    
   
 
@@ -1284,18 +1336,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 246 of file modules.cpp.
-

-
00247 {
-00248         if (IncludeSender)
-00249         {
-00250                 WriteCommon(User,"%s",text.c_str());
-00251         }
-00252         else
-00253         {
-00254                 WriteCommonExcept(User,"%s",text.c_str());
-00255         }
-00256 }
+Definition at line 253 of file modules.cpp.
+

+
00254 {
+00255         if (IncludeSender)
+00256         {
+00257                 WriteCommon(User,"%s",text.c_str());
+00258         }
+00259         else
+00260         {
+00261                 WriteCommonExcept(User,"%s",text.c_str());
+00262         }
+00263 }
 
    
   
 
@@ -1344,11 +1396,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 210 of file modules.cpp.
+Definition at line 217 of file modules.cpp.
 

-
00211 {
-00212         WriteFrom(Socket,User,"%s",s.c_str());
-00213 }
+
00218 {
+00219         WriteFrom(Socket,User,"%s",s.c_str());
+00220 }
 
    
   
 
@@ -1404,13 +1456,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 195 of file modules.cpp.
+Definition at line 202 of file modules.cpp.
 

 References server_mode().
 

-
00196 {
-00197         server_mode(parameters,pcnt,user);
-00198 }
+
00203 {
+00204         server_mode(parameters,pcnt,user);
+00205 }
 
    
   
 
@@ -1444,11 +1496,11 @@ Sends text to all opers.
 

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

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

-
00142 {
-00143         WriteOpers("%s",s.c_str());
-00144 }
+
00144 {
+00145         WriteOpers("%s",s.c_str());
+00146 }
 
    
   
 
@@ -1491,11 +1543,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 205 of file modules.cpp.
+Definition at line 212 of file modules.cpp.
 

-
00206 {
-00207         WriteServ(Socket,"%s",s.c_str());
-00208 }
+
00213 {
+00214         WriteServ(Socket,"%s",s.c_str());
+00215 }
 
    
   
 
@@ -1548,22 +1600,22 @@ The format will become:

 :localserver TEXT

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

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

-References connection::fd.
-

-
00216 {
-00217         if (!Source)
-00218         {
-00219                 // if source is NULL, then the message originates from the local server
-00220                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00221         }
-00222         else
-00223         {
-00224                 // otherwise it comes from the user specified
-00225                 WriteTo(Source,Dest,"%s",s.c_str());
-00226         }
-00227 }
+Definition at line 222 of file modules.cpp.
+

+References connection::fd.
+

+
00223 {
+00224         if (!Source)
+00225         {
+00226                 // if source is NULL, then the message originates from the local server
+00227                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00228         }
+00229         else
+00230         {
+00231                 // otherwise it comes from the user specified
+00232                 WriteTo(Source,Dest,"%s",s.c_str());
+00233         }
+00234 }
 
    
   
 
@@ -1614,11 +1666,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 154 of file modules.cpp.
+Definition at line 156 of file modules.cpp.
 

-
00155 {
-00156         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00157 }
+
00157 {
+00158         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00159 }
 
    
   
 
@@ -1661,17 +1713,17 @@ 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 258 of file modules.cpp.
+Definition at line 265 of file modules.cpp.
 

-
00259 {
-00260         WriteWallOps(User,false,"%s",text.c_str());
-00261 }
+
00266 {
+00267         WriteWallOps(User,false,"%s",text.c_str());
+00268 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Apr 19 02:34:49 2004 for InspIRCd by
+
Generated on Sun Apr 25 00:24:29 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3