docs/man/man3/Server.3

   1 .TH "Server" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Server \- 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.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <modules.h>\fP
  12 .PP
  13 Inherits \fBclassbase\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBServer\fP ()"
  20 .br
  21 .RI "\fIDefault constructor. \fP"
  22 .ti -1c
  23 .RI "virtual \fB~Server\fP ()"
  24 .br
  25 .RI "\fIDefault destructor. \fP"
  26 .ti -1c
  27 .RI "virtual void \fBSendOpers\fP (std::string s)"
  28 .br
  29 .RI "\fISends text to all opers. \fP"
  30 .ti -1c
  31 .RI "virtual void \fBLog\fP (int level, std::string s)"
  32 .br
  33 .RI "\fIWrites a log string. \fP"
  34 .ti -1c
  35 .RI "virtual void \fBSend\fP (int Socket, std::string s)"
  36 .br
  37 .RI "\fISends a line of text down a TCP/IP socket. \fP"
  38 .ti -1c
  39 .RI "virtual void \fBSendServ\fP (int Socket, std::string s)"
  40 .br
  41 .RI "\fISends text from the server to a socket. \fP"
  42 .ti -1c
  43 .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)"
  44 .br
  45 .RI "\fISends text from a user to a socket. \fP"
  46 .ti -1c
  47 .RI "virtual void \fBSendTo\fP (\fBuserrec\fP *Source, \fBuserrec\fP *Dest, std::string s)"
  48 .br
  49 .RI "\fISends text from a user to another user. \fP"
  50 .ti -1c
  51 .RI "virtual void \fBSendChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Channel, std::string s, bool IncludeSender)"
  52 .br
  53 .RI "\fISends text from a user to a channel (mulicast). \fP"
  54 .ti -1c
  55 .RI "virtual bool \fBCommonChannels\fP (\fBuserrec\fP *u1, \fBuserrec\fP *u2)"
  56 .br
  57 .RI "\fIReturns true if two users share a common channel. \fP"
  58 .ti -1c
  59 .RI "virtual void \fBSendCommon\fP (\fBuserrec\fP *User, std::string text, bool IncludeSender)"
  60 .br
  61 .RI "\fISends text from a user to one or more channels (mulicast). \fP"
  62 .ti -1c
  63 .RI "virtual void \fBSendWallops\fP (\fBuserrec\fP *User, std::string text)"
  64 .br
  65 .RI "\fISends a WALLOPS message. \fP"
  66 .ti -1c
  67 .RI "virtual bool \fBIsNick\fP (std::string nick)"
  68 .br
  69 .RI "\fIReturns true if a nick is valid. \fP"
  70 .ti -1c
  71 .RI "virtual int \fBCountUsers\fP (\fBchanrec\fP *c)"
  72 .br
  73 .RI "\fIReturns a count of the number of users on a channel. \fP"
  74 .ti -1c
  75 .RI "virtual \fBuserrec\fP * \fBFindNick\fP (std::string nick)"
  76 .br
  77 .RI "\fIAttempts to look up a nick and return a pointer to it. \fP"
  78 .ti -1c
  79 .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)"
  80 .br
  81 .RI "\fIAttempts to look up a channel and return a pointer to it. \fP"
  82 .ti -1c
  83 .RI "virtual std::string \fBChanMode\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  84 .br
  85 .RI "\fIAttempts to look up a user's privilages on a channel. \fP"
  86 .ti -1c
  87 .RI "virtual bool \fBIsOnChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  88 .br
  89 .RI "\fIChecks if a user is on a channel. \fP"
  90 .ti -1c
  91 .RI "virtual std::string \fBGetServerName\fP ()"
  92 .br
  93 .RI "\fIReturns the server name of the server where the module is loaded. \fP"
  94 .ti -1c
  95 .RI "virtual std::string \fBGetNetworkName\fP ()"
  96 .br
  97 .RI "\fIReturns the network name, global to all linked servers. \fP"
  98 .ti -1c
  99 .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()"
 100 .br
 101 .RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP"
 102 .ti -1c
 103 .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)"
 104 .br
 105 .RI "\fIAdds an extended mode letter which is parsed by a module. \fP"
 106 .ti -1c
 107 .RI "virtual bool \fBAddExtendedListMode\fP (char modechar)"
 108 .br
 109 .RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP"
 110 .ti -1c
 111 .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)"
 112 .br
 113 .RI "\fIAdds a command to the command table. \fP"
 114 .ti -1c
 115 .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 116 .br
 117 .RI "\fISends a servermode. \fP"
 118 .ti -1c
 119 .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)"
 120 .br
 121 .RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter. \fP"
 122 .ti -1c
 123 .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)"
 124 .br
 125 .RI "\fIForces a user to join a channel. \fP"
 126 .ti -1c
 127 .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)"
 128 .br
 129 .RI "\fIForces a user to part a channel. \fP"
 130 .ti -1c
 131 .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)"
 132 .br
 133 .RI "\fIForces a user nickchange. \fP"
 134 .ti -1c
 135 .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)"
 136 .br
 137 .RI "\fIForces a user to quit with the specified reason. \fP"
 138 .ti -1c
 139 .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)"
 140 .br
 141 .RI "\fIMatches text against a glob pattern. \fP"
 142 .ti -1c
 143 .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)"
 144 .br
 145 .RI "\fICalls the handler for a command, either implemented by the core or by another module. \fP"
 146 .ti -1c
 147 .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)"
 148 .br
 149 .RI "\fIChange displayed hostname of a user. \fP"
 150 .ti -1c
 151 .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)"
 152 .br
 153 .RI "\fIChange GECOS (fullname) of a user. \fP"
 154 .ti -1c
 155 .RI "virtual bool \fBIsUlined\fP (std::string server)"
 156 .br
 157 .RI "\fIReturns true if the servername you give is ulined. \fP"
 158 .ti -1c
 159 .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)"
 160 .br
 161 .RI "\fIFetches the userlist of a channel. \fP"
 162 .ti -1c
 163 .RI "virtual bool \fBUserToPseudo\fP (\fBuserrec\fP *user, std::string message)"
 164 .br
 165 .RI "\fIRemove a user's connection to the irc server, but leave their client in existence in the user hash. \fP"
 166 .ti -1c
 167 .RI "virtual bool \fBPseudoToUser\fP (\fBuserrec\fP *alive, \fBuserrec\fP *zombie, std::string message)"
 168 .br
 169 .RI "\fIThis user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. \fP"
 170 .ti -1c
 171 .RI "virtual void \fBAddGLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 172 .br
 173 .RI "\fIAdds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 174 .ti -1c
 175 .RI "virtual void \fBAddQLine\fP (long duration, std::string source, std::string reason, std::string nickname)"
 176 .br
 177 .RI "\fIAdds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 178 .ti -1c
 179 .RI "virtual void \fBAddZLine\fP (long duration, std::string source, std::string reason, std::string ipaddr)"
 180 .br
 181 .RI "\fIAdds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 182 .ti -1c
 183 .RI "virtual void \fBAddKLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 184 .br
 185 .RI "\fIAdds a K-line The K-line is enforced as soon as it is added. \fP"
 186 .ti -1c
 187 .RI "virtual void \fBAddELine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 188 .br
 189 .RI "\fIAdds a E-line The E-line is enforced as soon as it is added. \fP"
 190 .ti -1c
 191 .RI "virtual bool \fBDelGLine\fP (std::string hostmask)"
 192 .br
 193 .RI "\fIDeletes a G-Line from all servers on the mesh. \fP"
 194 .ti -1c
 195 .RI "virtual bool \fBDelQLine\fP (std::string nickname)"
 196 .br
 197 .RI "\fIDeletes a Q-Line from all servers on the mesh. \fP"
 198 .ti -1c
 199 .RI "virtual bool \fBDelZLine\fP (std::string ipaddr)"
 200 .br
 201 .RI "\fIDeletes a Z-Line from all servers on the mesh. \fP"
 202 .ti -1c
 203 .RI "virtual bool \fBDelKLine\fP (std::string hostmask)"
 204 .br
 205 .RI "\fIDeletes a local K-Line. \fP"
 206 .ti -1c
 207 .RI "virtual bool \fBDelELine\fP (std::string hostmask)"
 208 .br
 209 .RI "\fIDeletes a local E-Line. \fP"
 210 .ti -1c
 211 .RI "virtual long \fBCalcDuration\fP (std::string duration)"
 212 .br
 213 .RI "\fICalculates a duration This method will take a string containing a formatted duration (e.g. \fP"
 214 .in -1c
 215 .SH "Detailed Description"
 216 .PP
 217 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.
 218
 219 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 220 .PP
 221 Definition at line 385 of file modules.h.
 222 .SH "Constructor & Destructor Documentation"
 223 .PP
 224 .SS "Server::Server ()"
 225 .PP
 226 Default constructor. Creates a Server object.Definition at line 339 of file modules.cpp.
 227 .PP
 228 .nf
 229 340 {
 230 341 }
 231 .fi
 232 .SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
 233 .PP
 234 Default destructor. Destroys a Server object.Definition at line 343 of file modules.cpp.
 235 .PP
 236 .nf
 237 344 {
 238 345 }
 239 .fi
 240 .SH "Member Function Documentation"
 241 .PP
 242 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP"
 243 .PP
 244 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:
 245 .PP
 246 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 247 .PP
 248 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 420 of file modules.cpp.
 249 .PP
 250 References createcommand().
 251 .PP
 252 .nf
 253 421 {
 254 422         createcommand(cmd,f,flags,minparams,source);
 255 423 }
 256 .fi
 257 .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 258 .PP
 259 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 \fBServer::CalcDuration\fP 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 638 of file modules.cpp.
 260 .PP
 261 References add_eline(), and duration().
 262 .PP
 263 .nf
 264 639 {
 265 640         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 266 641 }
 267 .fi
 268 .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
 269 .PP
 270 Adds an extended mode letter which is parsed by a module and handled in a list fashion. This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:
 271 .PP
 272 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
 273 .PP
 274 (2) They always take exactly one parameter when being added or removed
 275 .PP
 276 (3) They can be set multiple times, usually on users in channels
 277 .PP
 278 (4) The mode and its parameter are NOT stored in the channels modes structure
 279 .PP
 280 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 565 of file modules.cpp.
 281 .PP
 282 References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 283 .PP
 284 .nf
 285 566 {
 286 567         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
 287 568         if (res)
 288 569                 ModeMakeList(modechar);
 289 570         return res;
 290 571 }
 291 .fi
 292 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 293 .PP
 294 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 545 of file modules.cpp.
 295 .PP
 296 References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 297 .PP
 298 .nf
 299 546 {
 300 547         if (type == MT_SERVER)
 301 548         {
 302 549                 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 303 550                 return false;
 304 551         }
 305 552         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 306 553         {
 307 554                 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 308 555                 return false;
 309 556         }
 310 557         if ((params_when_on>1) || (params_when_off>1))
 311 558         {
 312 559                 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 313 560                 return false;
 314 561         }
 315 562         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 316 563 }
 317 .fi
 318 .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 319 .PP
 320 Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 618 of file modules.cpp.
 321 .PP
 322 References add_gline(), and duration().
 323 .PP
 324 .nf
 325 619 {
 326 620         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 327 621 }
 328 .fi
 329 .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 330 .PP
 331 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 \fBServer::CalcDuration\fP 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 633 of file modules.cpp.
 332 .PP
 333 References add_kline(), and duration().
 334 .PP
 335 .nf
 336 634 {
 337 635         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 338 636 }
 339 .fi
 340 .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
 341 .PP
 342 Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 623 of file modules.cpp.
 343 .PP
 344 References add_qline(), and duration().
 345 .PP
 346 .nf
 347 624 {
 348 625         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
 349 626 }
 350 .fi
 351 .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
 352 .PP
 353 Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 628 of file modules.cpp.
 354 .PP
 355 References add_zline(), and duration().
 356 .PP
 357 .nf
 358 629 {
 359 630         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
 360 631 }
 361 .fi
 362 .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
 363 .PP
 364 Calculates a duration This method will take a string containing a formatted duration (e.g. '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 668 of file modules.cpp.
 365 .PP
 366 References duration().
 367 .PP
 368 .nf
 369 669 {
 370 670         return duration(delta.c_str());
 371 671 }
 372 .fi
 373 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 374 .PP
 375 Calls the handler for a command, either implemented by the core or by another module. 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
 376 .br
 377 ) 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 \fBAddCommand()\fP. 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 410 of file modules.cpp.
 378 .PP
 379 .nf
 380 411 {
 381 412         call_handler(commandname.c_str(),parameters,pcnt,user);
 382 413 }
 383 .fi
 384 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 385 .PP
 386 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 498 of file modules.cpp.
 387 .PP
 388 References ChangeName().
 389 .PP
 390 .nf
 391 499 {
 392 500         ChangeName(user,gecos.c_str());
 393 501 }
 394 .fi
 395 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 396 .PP
 397 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 493 of file modules.cpp.
 398 .PP
 399 References ChangeDisplayedHost().
 400 .PP
 401 .nf
 402 494 {
 403 495         ChangeDisplayedHost(user,host.c_str());
 404 496 }
 405 .fi
 406 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 407 .PP
 408 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 394 of file modules.cpp.
 409 .PP
 410 .nf
 411 395 {
 412 396         force_nickchange(user,nickname.c_str());
 413 397 }
 414 .fi
 415 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 416 .PP
 417 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 518 of file modules.cpp.
 418 .PP
 419 References cmode().
 420 .PP
 421 .nf
 422 519 {
 423 520         return cmode(User,Chan);
 424 521 }
 425 .fi
 426 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 427 .PP
 428 Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 471 of file modules.cpp.
 429 .PP
 430 References common_channels().
 431 .PP
 432 .nf
 433 472 {
 434 473         return (common_channels(u1,u2) != 0);
 435 474 }
 436 .fi
 437 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 438 .PP
 439 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 573 of file modules.cpp.
 440 .PP
 441 .nf
 442 574 {
 443 575         return usercount(c);
 444 576 }
 445 .fi
 446 .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
 447 .PP
 448 Deletes a local E-Line. Definition at line 663 of file modules.cpp.
 449 .PP
 450 References del_eline().
 451 .PP
 452 .nf
 453 664 {
 454 665         del_eline(hostmask.c_str());
 455 666 }
 456 .fi
 457 .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
 458 .PP
 459 Deletes a G-Line from all servers on the mesh. Definition at line 643 of file modules.cpp.
 460 .PP
 461 References del_gline().
 462 .PP
 463 .nf
 464 644 {
 465 645         del_gline(hostmask.c_str());
 466 646 }
 467 .fi
 468 .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
 469 .PP
 470 Deletes a local K-Line. Definition at line 658 of file modules.cpp.
 471 .PP
 472 References del_kline().
 473 .PP
 474 .nf
 475 659 {
 476 660         del_kline(hostmask.c_str());
 477 661 }
 478 .fi
 479 .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
 480 .PP
 481 Deletes a Q-Line from all servers on the mesh. Definition at line 648 of file modules.cpp.
 482 .PP
 483 References del_qline().
 484 .PP
 485 .nf
 486 649 {
 487 650         del_qline(nickname.c_str());
 488 651 }
 489 .fi
 490 .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
 491 .PP
 492 Deletes a Z-Line from all servers on the mesh. Definition at line 653 of file modules.cpp.
 493 .PP
 494 References del_zline().
 495 .PP
 496 .nf
 497 654 {
 498 655         del_zline(ipaddr.c_str());
 499 656 }
 500 .fi
 501 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 502 .PP
 503 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 513 of file modules.cpp.
 504 .PP
 505 .nf
 506 514 {
 507 515         return FindChan(channel.c_str());
 508 516 }
 509 .fi
 510 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 511 .PP
 512 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 508 of file modules.cpp.
 513 .PP
 514 .nf
 515 509 {
 516 510         return Find(nick);
 517 511 }
 518 .fi
 519 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 520 .PP
 521 Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 538 of file modules.cpp.
 522 .PP
 523 .nf
 524 539 {
 525 540         return Admin(getadminname(),getadminemail(),getadminnick());
 526 541 }
 527 .fi
 528 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 529 .PP
 530 Returns the network name, global to all linked servers. Definition at line 533 of file modules.cpp.
 531 .PP
 532 .nf
 533 534 {
 534 535         return getnetworkname();
 535 536 }
 536 .fi
 537 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 538 .PP
 539 Returns the server name of the server where the module is loaded. Definition at line 528 of file modules.cpp.
 540 .PP
 541 .nf
 542 529 {
 543 530         return getservername();
 544 531 }
 545 .fi
 546 .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
 547 .PP
 548 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 375 of file modules.cpp.
 549 .PP
 550 References chanuserlist, clientlist, has_channel(), and isnick().
 551 .PP
 552 .nf
 553 376 {
 554 377         chanuserlist userl;
 555 378         userl.clear();
 556 379         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 557 380         {
 558 381                 if (i->second)
 559 382                 {
 560 383                         if (has_channel(i->second,chan))
 561 384                         {
 562 385                                 if (isnick(i->second->nick))
 563 386                                 {
 564 387                                         userl.push_back(i->second);
 565 388                                 }
 566 389                         }
 567 390                 }
 568 391         }
 569 392         return userl;
 570 393 }
 571 .fi
 572 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 573 .PP
 574 Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 503 of file modules.cpp.
 575 .PP
 576 References isnick().
 577 .PP
 578 .nf
 579 504 {
 580 505         return (isnick(nick.c_str()) != 0);
 581 506 }
 582 .fi
 583 .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 584 .PP
 585 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 523 of file modules.cpp.
 586 .PP
 587 References has_channel().
 588 .PP
 589 .nf
 590 524 {
 591 525         return has_channel(User,Chan);
 592 526 }
 593 .fi
 594 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 595 .PP
 596 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 405 of file modules.cpp.
 597 .PP
 598 References is_uline().
 599 .PP
 600 .nf
 601 406 {
 602 407         return is_uline(server.c_str());
 603 408 }
 604 .fi
 605 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 606 .PP
 607 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 365 of file modules.cpp.
 608 .PP
 609 .nf
 610 366 {
 611 367         return add_channel(user,cname.c_str(),key.c_str(),true);
 612 368 }
 613 .fi
 614 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 615 .PP
 616 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 415 of file modules.cpp.
 617 .PP
 618 .nf
 619 416 {
 620 417         log(level,'%s',s.c_str());
 621 418 }
 622 .fi
 623 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 624 .PP
 625 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 352 of file modules.cpp.
 626 .PP
 627 .nf
 628 353 {
 629 354         char literal[MAXBUF],pattern[MAXBUF];
 630 355         strlcpy(literal,sliteral.c_str(),MAXBUF);
 631 356         strlcpy(pattern,spattern.c_str(),MAXBUF);
 632 357         return match(literal,pattern);
 633 358 }
 634 .fi
 635 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 636 .PP
 637 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 370 of file modules.cpp.
 638 .PP
 639 .nf
 640 371 {
 641 372         return del_channel(user,cname.c_str(),reason.c_str(),false);
 642 373 }
 643 .fi
 644 .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
 645 .PP
 646 This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. 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 588 of file modules.cpp.
 647 .PP
 648 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.
 649 .PP
 650 .nf
 651 589 {
 652 590         zombie->fd = alive->fd;
 653 591         alive->fd = FD_MAGIC_NUMBER;
 654 592         Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
 655 593         kill_link(alive,message.c_str());
 656 594         for (int i = 0; i != MAXCHANS; i++)
 657 595         {
 658 596                 if (zombie->chans[i].channel != NULL)
 659 597                 {
 660 598                         if (zombie->chans[i].channel->name)
 661 599                         {
 662 600                                 chanrec* Ptr = zombie->chans[i].channel;
 663 601                                 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
 664 602                                 if (Ptr->topicset)
 665 603                                 {
 666 604                                         WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
 667 605                                         WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
 668 606                                 }
 669 607                                 userlist(zombie,Ptr);
 670 608                                 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
 671 609                                 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr));
 672 610                                 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created);
 673 611
 674 612                         }
 675 613                 }
 676 614         }
 677 615
 678 616 }
 679 .fi
 680 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 681 .PP
 682 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.
 683 .PP
 684 WARNING!
 685 .PP
 686 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 399 of file modules.cpp.
 687 .PP
 688 References userrec::nick, and send_network_quit().
 689 .PP
 690 .nf
 691 400 {
 692 401         send_network_quit(user->nick,reason.c_str());
 693 402         kill_link(user,reason.c_str());
 694 403 }
 695 .fi
 696 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 697 .PP
 698 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 430 of file modules.cpp.
 699 .PP
 700 .nf
 701 431 {
 702 432         Write(Socket,'%s',s.c_str());
 703 433 }
 704 .fi
 705 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 706 .PP
 707 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 459 of file modules.cpp.
 708 .PP
 709 .nf
 710 460 {
 711 461         if (IncludeSender)
 712 462         {
 713 463                 WriteChannel(Channel,User,'%s',s.c_str());
 714 464         }
 715 465         else
 716 466         {
 717 467                 ChanExceptSender(Channel,User,'%s',s.c_str());
 718 468         }
 719 469 }
 720 .fi
 721 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 722 .PP
 723 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 476 of file modules.cpp.
 724 .PP
 725 .nf
 726 477 {
 727 478         if (IncludeSender)
 728 479         {
 729 480                 WriteCommon(User,'%s',text.c_str());
 730 481         }
 731 482         else
 732 483         {
 733 484                 WriteCommonExcept(User,'%s',text.c_str());
 734 485         }
 735 486 }
 736 .fi
 737 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 738 .PP
 739 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 440 of file modules.cpp.
 740 .PP
 741 .nf
 742 441 {
 743 442         WriteFrom(Socket,User,'%s',s.c_str());
 744 443 }
 745 .fi
 746 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 747 .PP
 748 Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes.
 749 .PP
 750 For example:
 751 .PP
 752 char *modes[3];
 753 .PP
 754 modes[0] = ChannelName;
 755 .PP
 756 modes[1] = '+o';
 757 .PP
 758 modes[2] = user->nick;
 759 .PP
 760 Srv->SendMode(modes,3,user);
 761 .PP
 762 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 425 of file modules.cpp.
 763 .PP
 764 References server_mode().
 765 .PP
 766 .nf
 767 426 {
 768 427         server_mode(parameters,pcnt,user);
 769 428 }
 770 .fi
 771 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 772 .PP
 773 Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 347 of file modules.cpp.
 774 .PP
 775 .nf
 776 348 {
 777 349         WriteOpers('%s',s.c_str());
 778 350 }
 779 .fi
 780 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 781 .PP
 782 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 435 of file modules.cpp.
 783 .PP
 784 .nf
 785 436 {
 786 437         WriteServ(Socket,'%s',s.c_str());
 787 438 }
 788 .fi
 789 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 790 .PP
 791 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) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:
 792 .PP
 793 :user!ident TEXT
 794 .PP
 795 The format will become:
 796 .PP
 797 :localserver TEXT
 798 .PP
 799 Which is useful for numerics and server notices to single users, etc.Definition at line 445 of file modules.cpp.
 800 .PP
 801 References connection::fd.
 802 .PP
 803 .nf
 804 446 {
 805 447         if (!Source)
 806 448         {
 807 449                 // if source is NULL, then the message originates from the local server
 808 450                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 809 451         }
 810 452         else
 811 453         {
 812 454                 // otherwise it comes from the user specified
 813 455                 WriteTo(Source,Dest,'%s',s.c_str());
 814 456         }
 815 457 }
 816 .fi
 817 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
 818 .PP
 819 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:
 820 .PP
 821 Serv->SendToModeMask('xi', WM_OR, 'm00');
 822 .PP
 823 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 360 of file modules.cpp.
 824 .PP
 825 .nf
 826 361 {
 827 362         WriteMode(modes.c_str(),flags,'%s',text.c_str());
 828 363 }
 829 .fi
 830 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
 831 .PP
 832 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 488 of file modules.cpp.
 833 .PP
 834 .nf
 835 489 {
 836 490         WriteWallOps(User,false,'%s',text.c_str());
 837 491 }
 838 .fi
 839 .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
 840 .PP
 841 Remove a user's connection to the irc server, but leave their client in existence in the user hash. 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 579 of file modules.cpp.
 842 .PP
 843 References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
 844 .PP
 845 .nf
 846 580 {
 847 581         unsigned int old_fd = user->fd;
 848 582         user->fd = FD_MAGIC_NUMBER;
 849 583         Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
 850 584         close(old_fd);
 851 585         shutdown (old_fd,2);
 852 586 }
 853 .fi
 854
 855
 856 .SH "Author"
 857 .PP
 858 Generated automatically by Doxygen for InspIRCd from the source code.