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. @@ -84,7 +88,7 @@ All modules should instantiate at least one copy of this class, and use its memb
-Definition at line 239 of file modules.h.
Constructor & Destructor Documentation
+Definition at line 240 of file modules.h.Constructor & Destructor Documentation
Destroys a Server object.
-Definition at line 134 of file modules.cpp. +Definition at line 135 of file modules.cpp.
-
00135 {
-00136 }
+00136 {
+00137 }
Member Function Documentation
-
|
@@ -211,17 +215,17 @@ 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 174 of file modules.cpp. +Definition at line 183 of file modules.cpp. References createcommand(). - 00175 {
-00176 createcommand(cmd,f,flags,minparams);
-00177 }
+ |
|
@@ -278,32 +282,32 @@ 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 275 of file modules.cpp. - -References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. - - 00276 {
-00277 if (type == MT_SERVER)
-00278 {
-00279 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00280 return false;
-00281 }
-00282 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00283 {
-00284 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00285 return false;
-00286 }
-00287 if ((params_when_on>1) || (params_when_off>1))
-00288 {
-00289 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00290 return false;
-00291 }
-00292 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00293 }
+Definition at line 293 of file modules.cpp.
+ |
|
@@ -342,15 +346,15 @@ 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 158 of file modules.cpp. +Definition at line 167 of file modules.cpp. - 00159 {
-00160 force_nickchange(user,nickname.c_str());
-00161 }
+ |
|
@@ -389,11 +393,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 253 of file modules.cpp. +Definition at line 271 of file modules.cpp. - 00254 {
-00255 return cmode(User,Chan);
-00256 }
+ |
This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
-Definition at line 216 of file modules.cpp. +Definition at line 234 of file modules.cpp.
-
00217 {
-00218 return (common_channels(u1,u2) != 0);
-00219 }
+00235 {
+00236 return (common_channels(u1,u2) != 0);
+00237 }
-
+
+
|
+
| + + | +
+
+ +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 313 of file modules.cpp. + + 00314 {
+00315 return usercount(c);
+00316 }
+ |
+
|
@@ -474,15 +516,15 @@ 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 248 of file modules.cpp. +Definition at line 266 of file modules.cpp. - 00249 {
-00250 return FindChan(channel.c_str());
-00251 }
+ |
|
@@ -512,15 +554,15 @@ 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 243 of file modules.cpp. +Definition at line 261 of file modules.cpp. - 00244 {
-00245 return Find(nick);
-00246 }
+ |
|
@@ -549,15 +591,15 @@ 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 268 of file modules.cpp. +Definition at line 286 of file modules.cpp. - |
|
@@ -586,15 +628,15 @@ Returns the network name, global to all linked servers.
-Definition at line 263 of file modules.cpp. +Definition at line 281 of file modules.cpp. - 00264 {
-00265 return getnetworkname();
-00266 }
+ |
|
@@ -623,11 +665,11 @@ Returns the server name of the server where the module is loaded.
-Definition at line 258 of file modules.cpp. +Definition at line 276 of file modules.cpp. - 00259 {
-00260 return getservername();
-00261 }
+ |
Nicks for unregistered connections will return false.
-Definition at line 238 of file modules.cpp. +Definition at line 256 of file modules.cpp. +
+
00257 {
+00258 return (isnick(nick.c_str()) != 0);
+00259 }
++
+
|
+ ||||||||||||||||
| + + | +
+
+ +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 157 of file modules.cpp. - 00239 {
-00240 return (isnick(nick.c_str()) != 0);
-00241 }
+ |
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 169 of file modules.cpp. +Definition at line 178 of file modules.cpp. +
+
00179 {
+00180 log(level,"%s",s.c_str());
+00181 }
++
+
|
+ ||||||||||||
| + + | +
+
+ +Matches text against a glob pattern. - 00170 {
-00171 log(level,"%s",s.c_str());
-00172 }
+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.
+ |
+
+
|
+ ||||||||||||||||
| + + | +
+
+ +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 162 of file modules.cpp. + + 00163 {
+00164 return del_channel(user,cname.c_str(),reason.c_str());
+00165 }
+ |
+
|
@@ -757,11 +955,11 @@ 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 163 of file modules.cpp. +Definition at line 172 of file modules.cpp. - 00164 {
-00165 kill_link(user,reason.c_str());
-00166 }
+ |
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 184 of file modules.cpp. +Definition at line 193 of file modules.cpp.
-
00185 {
-00186 Write(Socket,"%s",s.c_str());
-00187 }
+00194 {
+00195 Write(Socket,"%s",s.c_str());
+00196 }
@@ -863,18 +1061,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 204 of file modules.cpp.
-
-
00205 {
-00206 if (IncludeSender)
-00207 {
-00208 WriteChannel(Channel,User,"%s",s.c_str());
-00209 }
-00210 else
-00211 {
-00212 ChanExceptSender(Channel,User,"%s",s.c_str());
-00213 }
-00214 }
+Definition at line 222 of file modules.cpp.
+
+
00223 {
+00224 if (IncludeSender)
+00225 {
+00226 WriteChannel(Channel,User,"%s",s.c_str());
+00227 }
+00228 else
+00229 {
+00230 ChanExceptSender(Channel,User,"%s",s.c_str());
+00231 }
+00232 }
@@ -923,18 +1121,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 221 of file modules.cpp.
-
-
00222 {
-00223 if (IncludeSender)
-00224 {
-00225 WriteCommon(User,"%s",text.c_str());
-00226 }
-00227 else
-00228 {
-00229 WriteCommonExcept(User,"%s",text.c_str());
-00230 }
-00231 }
+Definition at line 239 of file modules.cpp.
+
+
00240 {
+00241 if (IncludeSender)
+00242 {
+00243 WriteCommon(User,"%s",text.c_str());
+00244 }
+00245 else
+00246 {
+00247 WriteCommonExcept(User,"%s",text.c_str());
+00248 }
+00249 }
@@ -983,15 +1181,15 @@ 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 194 of file modules.cpp.
+Definition at line 203 of file modules.cpp.
-
00195 {
-00196 WriteFrom(Socket,User,"%s",s.c_str());
-00197 }
+00204 {
+00205 WriteFrom(Socket,User,"%s",s.c_str());
+00206 }
-
@@ -1043,13 +1241,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 179 of file modules.cpp.
+Definition at line 188 of file modules.cpp.
References server_mode().
-
00180 {
-00181 server_mode(parameters,pcnt,user);
-00182 }
+00189 {
+00190 server_mode(parameters,pcnt,user);
+00191 }
@@ -1083,11 +1281,11 @@ Sends text to all opers.
This method sends a server notice to all opers with the usermode +s.
-Definition at line 138 of file modules.cpp.
+Definition at line 139 of file modules.cpp.
-
00139 {
-00140 WriteOpers("%s",s.c_str());
-00141 }
+00140 {
+00141 WriteOpers("%s",s.c_str());
+00142 }
@@ -1130,11 +1328,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 189 of file modules.cpp.
+Definition at line 198 of file modules.cpp.
-
00190 {
-00191 WriteServ(Socket,"%s",s.c_str());
-00192 }
+00199 {
+00200 WriteServ(Socket,"%s",s.c_str());
+00201 }
@@ -1181,17 +1379,32 @@ Definition at line 189
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)
+This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:
+:user!ident TEXT
+The format will become:
+:localserver TEXT
+Which is useful for numerics and server notices to single users, etc.
-Definition at line 199 of file modules.cpp.
+Definition at line 208 of file modules.cpp.
-
00200 {
-00201 WriteTo(Source,Dest,"%s",s.c_str());
-00202 }
+References connection::fd.
+
+
00209 {
+00210 if (!Source)
+00211 {
+00212 // if source is NULL, then the message originates from the local server
+00213 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00214 }
+00215 else
+00216 {
+00217 // otherwise it comes from the user specified
+00218 WriteTo(Source,Dest,"%s",s.c_str());
+00219 }
+00220 }
-
@@ -1238,11 +1451,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 143 of file modules.cpp.
+Definition at line 152 of file modules.cpp.
-
00144 {
-00145 WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00146 }
+00153 {
+00154 WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00155 }
@@ -1285,109 +1498,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 233 of file modules.cpp.
+Definition at line 251 of file modules.cpp.
-
00234 {
-00235 WriteWallOps(User,"%s",text.c_str());
-00236 }
+00252 {
+00253 WriteWallOps(User,"%s",text.c_str());
+00254 }
-
-
-
-
-
-
- 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 Tue Apr 6 21:14:13 2004 for InspIRCd by
+
Generated on Wed Apr 7 19:20:54 2004 for InspIRCd by
1.3-rc3
--
cgit v1.3.1-10-gc9f91