docs/man/man3/Server.3

   1 .TH "Server" 3 "12 May 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 \fBSendChannelServerNotice\fP (std::string ServName, \fBchanrec\fP *Channel, std::string text)"
  44 .br
  45 .RI "\fIWrites text to a channel, but from a server, including all. \fP"
  46 .ti -1c
  47 .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)"
  48 .br
  49 .RI "\fISends text from a user to a socket. \fP"
  50 .ti -1c
  51 .RI "virtual void \fBSendTo\fP (\fBuserrec\fP *Source, \fBuserrec\fP *Dest, std::string s)"
  52 .br
  53 .RI "\fISends text from a user to another user. \fP"
  54 .ti -1c
  55 .RI "virtual void \fBSendChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Channel, std::string s, bool IncludeSender)"
  56 .br
  57 .RI "\fISends text from a user to a channel (mulicast). \fP"
  58 .ti -1c
  59 .RI "virtual bool \fBCommonChannels\fP (\fBuserrec\fP *u1, \fBuserrec\fP *u2)"
  60 .br
  61 .RI "\fIReturns true if two users share a common channel. \fP"
  62 .ti -1c
  63 .RI "virtual void \fBSendCommon\fP (\fBuserrec\fP *User, std::string text, bool IncludeSender)"
  64 .br
  65 .RI "\fISends text from a user to one or more channels (mulicast). \fP"
  66 .ti -1c
  67 .RI "virtual void \fBSendWallops\fP (\fBuserrec\fP *User, std::string text)"
  68 .br
  69 .RI "\fISends a WALLOPS message. \fP"
  70 .ti -1c
  71 .RI "virtual bool \fBIsNick\fP (std::string nick)"
  72 .br
  73 .RI "\fIReturns true if a nick is valid. \fP"
  74 .ti -1c
  75 .RI "virtual int \fBCountUsers\fP (\fBchanrec\fP *c)"
  76 .br
  77 .RI "\fIReturns a count of the number of users on a channel. \fP"
  78 .ti -1c
  79 .RI "virtual \fBuserrec\fP * \fBFindNick\fP (std::string nick)"
  80 .br
  81 .RI "\fIAttempts to look up a nick and return a pointer to it. \fP"
  82 .ti -1c
  83 .RI "virtual \fBuserrec\fP * \fBFindDescriptor\fP (int socket)"
  84 .br
  85 .RI "\fIAttempts to look up a nick using the file descriptor associated with that nick. \fP"
  86 .ti -1c
  87 .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)"
  88 .br
  89 .RI "\fIAttempts to look up a channel and return a pointer to it. \fP"
  90 .ti -1c
  91 .RI "virtual std::string \fBChanMode\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  92 .br
  93 .RI "\fIAttempts to look up a user's privilages on a channel. \fP"
  94 .ti -1c
  95 .RI "virtual bool \fBIsOnChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  96 .br
  97 .RI "\fIChecks if a user is on a channel. \fP"
  98 .ti -1c
  99 .RI "virtual std::string \fBGetServerName\fP ()"
 100 .br
 101 .RI "\fIReturns the server name of the server where the module is loaded. \fP"
 102 .ti -1c
 103 .RI "virtual std::string \fBGetNetworkName\fP ()"
 104 .br
 105 .RI "\fIReturns the network name, global to all linked servers. \fP"
 106 .ti -1c
 107 .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()"
 108 .br
 109 .RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP"
 110 .ti -1c
 111 .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)"
 112 .br
 113 .RI "\fIAdds an extended mode letter which is parsed by a module. \fP"
 114 .ti -1c
 115 .RI "virtual bool \fBAddExtendedListMode\fP (char modechar)"
 116 .br
 117 .RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP"
 118 .ti -1c
 119 .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)"
 120 .br
 121 .RI "\fIAdds a command to the command table. \fP"
 122 .ti -1c
 123 .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 124 .br
 125 .RI "\fISends a servermode. \fP"
 126 .ti -1c
 127 .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)"
 128 .br
 129 .RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter. \fP"
 130 .ti -1c
 131 .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)"
 132 .br
 133 .RI "\fIForces a user to join a channel. \fP"
 134 .ti -1c
 135 .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)"
 136 .br
 137 .RI "\fIForces a user to part a channel. \fP"
 138 .ti -1c
 139 .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)"
 140 .br
 141 .RI "\fIForces a user nickchange. \fP"
 142 .ti -1c
 143 .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)"
 144 .br
 145 .RI "\fIForces a user to quit with the specified reason. \fP"
 146 .ti -1c
 147 .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)"
 148 .br
 149 .RI "\fIMatches text against a glob pattern. \fP"
 150 .ti -1c
 151 .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)"
 152 .br
 153 .RI "\fICalls the handler for a command, either implemented by the core or by another module. \fP"
 154 .ti -1c
 155 .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)"
 156 .br
 157 .RI "\fIChange displayed hostname of a user. \fP"
 158 .ti -1c
 159 .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)"
 160 .br
 161 .RI "\fIChange GECOS (fullname) of a user. \fP"
 162 .ti -1c
 163 .RI "virtual bool \fBIsUlined\fP (std::string server)"
 164 .br
 165 .RI "\fIReturns true if the servername you give is ulined. \fP"
 166 .ti -1c
 167 .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)"
 168 .br
 169 .RI "\fIFetches the userlist of a channel. \fP"
 170 .ti -1c
 171 .RI "virtual bool \fBUserToPseudo\fP (\fBuserrec\fP *user, std::string message)"
 172 .br
 173 .RI "\fIRemove a user's connection to the irc server, but leave their client in existence in the user hash. \fP"
 174 .ti -1c
 175 .RI "virtual bool \fBPseudoToUser\fP (\fBuserrec\fP *alive, \fBuserrec\fP *zombie, std::string message)"
 176 .br
 177 .RI "\fIThis user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. \fP"
 178 .ti -1c
 179 .RI "virtual void \fBAddGLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 180 .br
 181 .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"
 182 .ti -1c
 183 .RI "virtual void \fBAddQLine\fP (long duration, std::string source, std::string reason, std::string nickname)"
 184 .br
 185 .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"
 186 .ti -1c
 187 .RI "virtual void \fBAddZLine\fP (long duration, std::string source, std::string reason, std::string ipaddr)"
 188 .br
 189 .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"
 190 .ti -1c
 191 .RI "virtual void \fBAddKLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 192 .br
 193 .RI "\fIAdds a K-line The K-line is enforced as soon as it is added. \fP"
 194 .ti -1c
 195 .RI "virtual void \fBAddELine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 196 .br
 197 .RI "\fIAdds a E-line The E-line is enforced as soon as it is added. \fP"
 198 .ti -1c
 199 .RI "virtual bool \fBDelGLine\fP (std::string hostmask)"
 200 .br
 201 .RI "\fIDeletes a G-Line from all servers on the mesh. \fP"
 202 .ti -1c
 203 .RI "virtual bool \fBDelQLine\fP (std::string nickname)"
 204 .br
 205 .RI "\fIDeletes a Q-Line from all servers on the mesh. \fP"
 206 .ti -1c
 207 .RI "virtual bool \fBDelZLine\fP (std::string ipaddr)"
 208 .br
 209 .RI "\fIDeletes a Z-Line from all servers on the mesh. \fP"
 210 .ti -1c
 211 .RI "virtual bool \fBDelKLine\fP (std::string hostmask)"
 212 .br
 213 .RI "\fIDeletes a local K-Line. \fP"
 214 .ti -1c
 215 .RI "virtual bool \fBDelELine\fP (std::string hostmask)"
 216 .br
 217 .RI "\fIDeletes a local E-Line. \fP"
 218 .ti -1c
 219 .RI "virtual long \fBCalcDuration\fP (std::string duration)"
 220 .br
 221 .RI "\fICalculates a duration This method will take a string containing a formatted duration (e.g. \fP"
 222 .ti -1c
 223 .RI "virtual bool \fBIsValidMask\fP (std::string mask)"
 224 .br
 225 .RI "\fIReturns true if a nick!ident string is correctly formatted, false if otherwise. \fP"
 226 .ti -1c
 227 .RI "virtual void \fBMeshSendAll\fP (std::string text)"
 228 .br
 229 .RI "\fISends a line of text to all connected servers. \fP"
 230 .ti -1c
 231 .RI "virtual void \fBMeshSendCommon\fP (\fBuserrec\fP *user, std::string text)"
 232 .br
 233 .RI "\fIThis method sends a line of text to all servers who have users which share common channels with the user you provide. \fP"
 234 .ti -1c
 235 .RI "virtual void \fBMeshSendAllAlive\fP (std::string text)"
 236 .br
 237 .RI "\fIThis function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. \fP"
 238 .ti -1c
 239 .RI "virtual void \fBMeshSendUnicast\fP (std::string destination, std::string text)"
 240 .br
 241 .RI "\fIThis function sends a line of text directly to a server. \fP"
 242 .ti -1c
 243 .RI "virtual void \fBMeshSendAllExcept\fP (std::string target, std::string text)"
 244 .br
 245 .RI "\fIThis function sends to all servers EXCEPT the one you specify. \fP"
 246 .ti -1c
 247 .RI "virtual bool \fBMeshCheckChan\fP (\fBchanrec\fP *c, std::string servername)"
 248 .br
 249 .RI "\fIThis function is used to check if any users on channel c are on server servername. \fP"
 250 .ti -1c
 251 .RI "virtual bool \fBMeshCheckCommon\fP (\fBuserrec\fP *u, std::string servername)"
 252 .br
 253 .RI "\fIThis function is used to check if user u has any channels in common with users on servername. \fP"
 254 .ti -1c
 255 .RI "virtual \fBModule\fP * \fBFindModule\fP (std::string name)"
 256 .br
 257 .RI "\fIThis function finds a module by name. \fP"
 258 .in -1c
 259 .SH "Detailed Description"
 260 .PP
 261 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.
 262
 263 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 264 .PP
 265 Definition at line 694 of file modules.h.
 266 .SH "Constructor & Destructor Documentation"
 267 .PP
 268 .SS "Server::Server ()"
 269 .PP
 270 Default constructor. Creates a Server object.Definition at line 431 of file modules.cpp.
 271 .PP
 272 .nf
 273 432 {
 274 433 }
 275 .fi
 276 .SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
 277 .PP
 278 Default destructor. Destroys a Server object.Definition at line 435 of file modules.cpp.
 279 .PP
 280 .nf
 281 436 {
 282 437 }
 283 .fi
 284 .SH "Member Function Documentation"
 285 .PP
 286 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP"
 287 .PP
 288 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:
 289 .PP
 290 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 291 .PP
 292 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 504 of file modules.cpp.
 293 .PP
 294 References createcommand().
 295 .PP
 296 .nf
 297 505 {
 298 506         createcommand(cmd,f,flags,minparams,source);
 299 507 }
 300 .fi
 301 .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 302 .PP
 303 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 750 of file modules.cpp.
 304 .PP
 305 References add_eline(), and duration().
 306 .PP
 307 .nf
 308 751 {
 309 752         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 310 753 }
 311 .fi
 312 .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
 313 .PP
 314 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:
 315 .PP
 316 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
 317 .PP
 318 (2) They always take exactly one parameter when being added or removed
 319 .PP
 320 (3) They can be set multiple times, usually on users in channels
 321 .PP
 322 (4) The mode and its parameter are NOT stored in the channels modes structure
 323 .PP
 324 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 667 of file modules.cpp.
 325 .PP
 326 References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 327 .PP
 328 .nf
 329 668 {
 330 669         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
 331 670         if (res)
 332 671                 ModeMakeList(modechar);
 333 672         return res;
 334 673 }
 335 .fi
 336 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 337 .PP
 338 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 639 of file modules.cpp.
 339 .PP
 340 References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 341 .PP
 342 .nf
 343 640 {
 344 641         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
 345 642         {
 346 643                 if (type == MT_SERVER)
 347 644                 {
 348 645                         log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 349 646                         return false;
 350 647                 }
 351 648                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 352 649                 {
 353 650                         log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 354 651                         return false;
 355 652                 }
 356 653                 if ((params_when_on>1) || (params_when_off>1))
 357 654                 {
 358 655                         log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 359 656                         return false;
 360 657                 }
 361 658                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 362 659         }
 363 660         else
 364 661         {
 365 662                 log(DEBUG,'*** API ERROR *** Muppet modechar detected.');
 366 663         }
 367 664         return false;
 368 665 }
 369 .fi
 370 .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 371 .PP
 372 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 730 of file modules.cpp.
 373 .PP
 374 References add_gline(), and duration().
 375 .PP
 376 .nf
 377 731 {
 378 732         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 379 733 }
 380 .fi
 381 .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 382 .PP
 383 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 745 of file modules.cpp.
 384 .PP
 385 References add_kline(), and duration().
 386 .PP
 387 .nf
 388 746 {
 389 747         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 390 748 }
 391 .fi
 392 .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
 393 .PP
 394 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 735 of file modules.cpp.
 395 .PP
 396 References add_qline(), and duration().
 397 .PP
 398 .nf
 399 736 {
 400 737         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
 401 738 }
 402 .fi
 403 .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
 404 .PP
 405 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 740 of file modules.cpp.
 406 .PP
 407 References add_zline(), and duration().
 408 .PP
 409 .nf
 410 741 {
 411 742         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
 412 743 }
 413 .fi
 414 .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
 415 .PP
 416 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 780 of file modules.cpp.
 417 .PP
 418 References duration().
 419 .PP
 420 .nf
 421 781 {
 422 782         return duration(delta.c_str());
 423 783 }
 424 .fi
 425 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 426 .PP
 427 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
 428 .br
 429 ) 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 494 of file modules.cpp.
 430 .PP
 431 .nf
 432 495 {
 433 496         call_handler(commandname.c_str(),parameters,pcnt,user);
 434 497 }
 435 .fi
 436 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 437 .PP
 438 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 587 of file modules.cpp.
 439 .PP
 440 References ChangeName().
 441 .PP
 442 .nf
 443 588 {
 444 589         ChangeName(user,gecos.c_str());
 445 590 }
 446 .fi
 447 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 448 .PP
 449 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 582 of file modules.cpp.
 450 .PP
 451 References ChangeDisplayedHost().
 452 .PP
 453 .nf
 454 583 {
 455 584         ChangeDisplayedHost(user,host.c_str());
 456 585 }
 457 .fi
 458 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 459 .PP
 460 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 479 of file modules.cpp.
 461 .PP
 462 .nf
 463 480 {
 464 481         force_nickchange(user,nickname.c_str());
 465 482 }
 466 .fi
 467 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 468 .PP
 469 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 612 of file modules.cpp.
 470 .PP
 471 References cmode().
 472 .PP
 473 .nf
 474 613 {
 475 614         return cmode(User,Chan);
 476 615 }
 477 .fi
 478 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 479 .PP
 480 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 560 of file modules.cpp.
 481 .PP
 482 References common_channels().
 483 .PP
 484 .nf
 485 561 {
 486 562         return (common_channels(u1,u2) != 0);
 487 563 }
 488 .fi
 489 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 490 .PP
 491 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 675 of file modules.cpp.
 492 .PP
 493 .nf
 494 676 {
 495 677         return usercount(c);
 496 678 }
 497 .fi
 498 .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
 499 .PP
 500 Deletes a local E-Line. Definition at line 775 of file modules.cpp.
 501 .PP
 502 References del_eline().
 503 .PP
 504 .nf
 505 776 {
 506 777         del_eline(hostmask.c_str());
 507 778 }
 508 .fi
 509 .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
 510 .PP
 511 Deletes a G-Line from all servers on the mesh. Definition at line 755 of file modules.cpp.
 512 .PP
 513 References del_gline().
 514 .PP
 515 .nf
 516 756 {
 517 757         del_gline(hostmask.c_str());
 518 758 }
 519 .fi
 520 .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
 521 .PP
 522 Deletes a local K-Line. Definition at line 770 of file modules.cpp.
 523 .PP
 524 References del_kline().
 525 .PP
 526 .nf
 527 771 {
 528 772         del_kline(hostmask.c_str());
 529 773 }
 530 .fi
 531 .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
 532 .PP
 533 Deletes a Q-Line from all servers on the mesh. Definition at line 760 of file modules.cpp.
 534 .PP
 535 References del_qline().
 536 .PP
 537 .nf
 538 761 {
 539 762         del_qline(nickname.c_str());
 540 763 }
 541 .fi
 542 .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
 543 .PP
 544 Deletes a Z-Line from all servers on the mesh. Definition at line 765 of file modules.cpp.
 545 .PP
 546 References del_zline().
 547 .PP
 548 .nf
 549 766 {
 550 767         del_zline(ipaddr.c_str());
 551 768 }
 552 .fi
 553 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 554 .PP
 555 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 607 of file modules.cpp.
 556 .PP
 557 .nf
 558 608 {
 559 609         return FindChan(channel.c_str());
 560 610 }
 561 .fi
 562 .SS "\fBuserrec\fP * Server::FindDescriptor (int socket)\fC [virtual]\fP"
 563 .PP
 564 Attempts to look up a nick using the file descriptor associated with that nick. This function will return NULL if the file descriptor is not associated with a valid user.Definition at line 602 of file modules.cpp.
 565 .PP
 566 References fd_ref_table.
 567 .PP
 568 .nf
 569 603 {
 570 604         return (socket < 65536 ? fd_ref_table[socket] : NULL);
 571 605 }
 572 .fi
 573 .SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP"
 574 .PP
 575 This function finds a module by name. You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.Definition at line 858 of file modules.cpp.
 576 .PP
 577 References MODCOUNT, module_names, and modules.
 578 .PP
 579 .nf
 580 859 {
 581 860         for (int i = 0; i <= MODCOUNT; i++)
 582 861         {
 583 862                 if (module_names[i] == name)
 584 863                 {
 585 864                         return modules[i];
 586 865                 }
 587 866         }
 588 867         return NULL;
 589 868 }
 590 .fi
 591 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 592 .PP
 593 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 597 of file modules.cpp.
 594 .PP
 595 .nf
 596 598 {
 597 599         return Find(nick);
 598 600 }
 599 .fi
 600 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 601 .PP
 602 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 632 of file modules.cpp.
 603 .PP
 604 .nf
 605 633 {
 606 634         return Admin(getadminname(),getadminemail(),getadminnick());
 607 635 }
 608 .fi
 609 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 610 .PP
 611 Returns the network name, global to all linked servers. Definition at line 627 of file modules.cpp.
 612 .PP
 613 .nf
 614 628 {
 615 629         return getnetworkname();
 616 630 }
 617 .fi
 618 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 619 .PP
 620 Returns the server name of the server where the module is loaded. Definition at line 622 of file modules.cpp.
 621 .PP
 622 .nf
 623 623 {
 624 624         return getservername();
 625 625 }
 626 .fi
 627 .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
 628 .PP
 629 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 467 of file modules.cpp.
 630 .PP
 631 References chanuserlist, chanrec::GetUsers(), and list.
 632 .PP
 633 .nf
 634 468 {
 635 469         chanuserlist userl;
 636 470         userl.clear();
 637 471         std::vector<char*> *list = chan->GetUsers();
 638 472         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
 639 473         {
 640 474                 char* o = *i;
 641 475                 userl.push_back((userrec*)o);
 642 476         }
 643 477         return userl;
 644 478 }
 645 .fi
 646 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 647 .PP
 648 Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 592 of file modules.cpp.
 649 .PP
 650 References isnick().
 651 .PP
 652 .nf
 653 593 {
 654 594         return (isnick(nick.c_str()) != 0);
 655 595 }
 656 .fi
 657 .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 658 .PP
 659 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 617 of file modules.cpp.
 660 .PP
 661 References has_channel().
 662 .PP
 663 .nf
 664 618 {
 665 619         return has_channel(User,Chan);
 666 620 }
 667 .fi
 668 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 669 .PP
 670 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 489 of file modules.cpp.
 671 .PP
 672 References is_uline().
 673 .PP
 674 .nf
 675 490 {
 676 491         return is_uline(server.c_str());
 677 492 }
 678 .fi
 679 .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP"
 680 .PP
 681 Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 785 of file modules.cpp.
 682 .PP
 683 .nf
 684 786 {
 685 787         const char* dest = mask.c_str();
 686 788         if (strchr(dest,'!')==0)
 687 789                 return false;
 688 790         if (strchr(dest,'@')==0)
 689 791                 return false;
 690 792         for (int i = 0; i < strlen(dest); i++)
 691 793                 if (dest[i] < 32)
 692 794                         return false;
 693 795         for (int i = 0; i < strlen(dest); i++)
 694 796                 if (dest[i] > 126)
 695 797                         return false;
 696 798         int c = 0;
 697 799         for (int i = 0; i < strlen(dest); i++)
 698 800                 if (dest[i] == '!')
 699 801                         c++;
 700 802         if (c>1)
 701 803                 return false;
 702 804         c = 0;
 703 805         for (int i = 0; i < strlen(dest); i++)
 704 806                 if (dest[i] == '@')
 705 807                         c++;
 706 808         if (c>1)
 707 809                 return false;
 708 810
 709 811         return true;
 710 812 }
 711 .fi
 712 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 713 .PP
 714 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 457 of file modules.cpp.
 715 .PP
 716 .nf
 717 458 {
 718 459         return add_channel(user,cname.c_str(),key.c_str(),false);
 719 460 }
 720 .fi
 721 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 722 .PP
 723 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 499 of file modules.cpp.
 724 .PP
 725 .nf
 726 500 {
 727 501         log(level,'%s',s.c_str());
 728 502 }
 729 .fi
 730 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 731 .PP
 732 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 444 of file modules.cpp.
 733 .PP
 734 .nf
 735 445 {
 736 446         char literal[MAXBUF],pattern[MAXBUF];
 737 447         strlcpy(literal,sliteral.c_str(),MAXBUF);
 738 448         strlcpy(pattern,spattern.c_str(),MAXBUF);
 739 449         return match(literal,pattern);
 740 450 }
 741 .fi
 742 .SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP"
 743 .PP
 744 This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 840 of file modules.cpp.
 745 .PP
 746 .nf
 747 841 {
 748 842         if (c)
 749 843         {
 750 844                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
 751 845         }
 752 846         else return false;
 753 847 }
 754 .fi
 755 .SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP"
 756 .PP
 757 This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 849 of file modules.cpp.
 758 .PP
 759 .nf
 760 850 {
 761 851         if (u)
 762 852         {
 763 853                 return CommonOnThisServer(u,(char*)servername.c_str());
 764 854         }
 765 855         else return false;
 766 856 }
 767 .fi
 768 .SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP"
 769 .PP
 770 Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 814 of file modules.cpp.
 771 .PP
 772 .nf
 773 815 {
 774 816         NetSendToAll((char*)text.c_str());
 775 817 }
 776 .fi
 777 .SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP"
 778 .PP
 779 This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 825 of file modules.cpp.
 780 .PP
 781 .nf
 782 826 {
 783 827         NetSendToAllAlive((char*)text.c_str());
 784 828 }
 785 .fi
 786 .SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP"
 787 .PP
 788 This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 835 of file modules.cpp.
 789 .PP
 790 .nf
 791 836 {
 792 837         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
 793 838 }
 794 .fi
 795 .SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP"
 796 .PP
 797 This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 819 of file modules.cpp.
 798 .PP
 799 .nf
 800 820 {
 801 821         if (user)
 802 822                 NetSendToCommon(user,(char*)text.c_str());
 803 823 }
 804 .fi
 805 .SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP"
 806 .PP
 807 This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 830 of file modules.cpp.
 808 .PP
 809 .nf
 810 831 {
 811 832         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
 812 833 }
 813 .fi
 814 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 815 .PP
 816 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 462 of file modules.cpp.
 817 .PP
 818 .nf
 819 463 {
 820 464         return del_channel(user,cname.c_str(),reason.c_str(),false);
 821 465 }
 822 .fi
 823 .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
 824 .PP
 825 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 700 of file modules.cpp.
 826 .PP
 827 References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
 828 .PP
 829 .nf
 830 701 {
 831 702         zombie->fd = alive->fd;
 832 703         alive->fd = FD_MAGIC_NUMBER;
 833 704         alive->ClearBuffer();
 834 705         Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
 835 706         kill_link(alive,message.c_str());
 836 707         fd_ref_table[zombie->fd] = zombie;
 837 708         for (int i = 0; i != MAXCHANS; i++)
 838 709         {
 839 710                 if (zombie->chans[i].channel != NULL)
 840 711                 {
 841 712                         if (zombie->chans[i].channel->name)
 842 713                         {
 843 714                                 chanrec* Ptr = zombie->chans[i].channel;
 844 715                                 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
 845 716                                 if (Ptr->topicset)
 846 717                                 {
 847 718                                         WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
 848 719                                         WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
 849 720                                 }
 850 721                                 userlist(zombie,Ptr);
 851 722                                 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
 852 723
 853 724                         }
 854 725                 }
 855 726         }
 856 727
 857 728 }
 858 .fi
 859 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 860 .PP
 861 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.
 862 .PP
 863 WARNING!
 864 .PP
 865 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 484 of file modules.cpp.
 866 .PP
 867 .nf
 868 485 {
 869 486         kill_link(user,reason.c_str());
 870 487 }
 871 .fi
 872 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 873 .PP
 874 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 514 of file modules.cpp.
 875 .PP
 876 .nf
 877 515 {
 878 516         Write(Socket,'%s',s.c_str());
 879 517 }
 880 .fi
 881 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 882 .PP
 883 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 548 of file modules.cpp.
 884 .PP
 885 .nf
 886 549 {
 887 550         if (IncludeSender)
 888 551         {
 889 552                 WriteChannel(Channel,User,'%s',s.c_str());
 890 553         }
 891 554         else
 892 555         {
 893 556                 ChanExceptSender(Channel,User,'%s',s.c_str());
 894 557         }
 895 558 }
 896 .fi
 897 .SS "void Server::SendChannelServerNotice (std::string ServName, \fBchanrec\fP * Channel, std::string text)\fC [virtual]\fP"
 898 .PP
 899 Writes text to a channel, but from a server, including all. This can be used to send server notices to a group of users.Definition at line 543 of file modules.cpp.
 900 .PP
 901 .nf
 902 544 {
 903 545         WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str());
 904 546 }
 905 .fi
 906 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 907 .PP
 908 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 565 of file modules.cpp.
 909 .PP
 910 .nf
 911 566 {
 912 567         if (IncludeSender)
 913 568         {
 914 569                 WriteCommon(User,'%s',text.c_str());
 915 570         }
 916 571         else
 917 572         {
 918 573                 WriteCommonExcept(User,'%s',text.c_str());
 919 574         }
 920 575 }
 921 .fi
 922 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 923 .PP
 924 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 524 of file modules.cpp.
 925 .PP
 926 .nf
 927 525 {
 928 526         WriteFrom(Socket,User,'%s',s.c_str());
 929 527 }
 930 .fi
 931 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 932 .PP
 933 Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes.
 934 .PP
 935 For example:
 936 .PP
 937 char *modes[3];
 938 .PP
 939 modes[0] = ChannelName;
 940 .PP
 941 modes[1] = '+o';
 942 .PP
 943 modes[2] = user->nick;
 944 .PP
 945 Srv->SendMode(modes,3,user);
 946 .PP
 947 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 509 of file modules.cpp.
 948 .PP
 949 References server_mode().
 950 .PP
 951 .nf
 952 510 {
 953 511         server_mode(parameters,pcnt,user);
 954 512 }
 955 .fi
 956 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 957 .PP
 958 Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 439 of file modules.cpp.
 959 .PP
 960 .nf
 961 440 {
 962 441         WriteOpers('%s',s.c_str());
 963 442 }
 964 .fi
 965 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 966 .PP
 967 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 519 of file modules.cpp.
 968 .PP
 969 .nf
 970 520 {
 971 521         WriteServ(Socket,'%s',s.c_str());
 972 522 }
 973 .fi
 974 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 975 .PP
 976 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:
 977 .PP
 978 :user!ident TEXT
 979 .PP
 980 The format will become:
 981 .PP
 982 :localserver TEXT
 983 .PP
 984 Which is useful for numerics and server notices to single users, etc.Definition at line 529 of file modules.cpp.
 985 .PP
 986 References connection::fd.
 987 .PP
 988 .nf
 989 530 {
 990 531         if (!Source)
 991 532         {
 992 533                 // if source is NULL, then the message originates from the local server
 993 534                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 994 535         }
 995 536         else
 996 537         {
 997 538                 // otherwise it comes from the user specified
 998 539                 WriteTo(Source,Dest,'%s',s.c_str());
 999 540         }
1000 541 }
1001 .fi
1002 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
1003 .PP
1004 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:
1005 .PP
1006 Serv->SendToModeMask('xi', WM_OR, 'm00');
1007 .PP
1008 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 452 of file modules.cpp.
1009 .PP
1010 .nf
1011 453 {
1012 454         WriteMode(modes.c_str(),flags,'%s',text.c_str());
1013 455 }
1014 .fi
1015 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
1016 .PP
1017 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 577 of file modules.cpp.
1018 .PP
1019 .nf
1020 578 {
1021 579         WriteWallOps(User,false,'%s',text.c_str());
1022 580 }
1023 .fi
1024 .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
1025 .PP
1026 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 681 of file modules.cpp.
1027 .PP
1028 References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
1029 .PP
1030 .nf
1031 682 {
1032 683         unsigned int old_fd = user->fd;
1033 684         user->fd = FD_MAGIC_NUMBER;
1034 685         user->ClearBuffer();
1035 686         Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
1036 687 #ifdef USE_KQUEUE
1037 688         struct kevent ke;
1038 689         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
1039 690         int i = kevent(kq, &ke, 1, 0, 0, NULL);
1040 691         if (i == -1)
1041 692         {
1042 693                 log(DEBUG,'kqueue: Failed to remove user from queue!');
1043 694         }
1044 695 #endif
1045 696         shutdown(old_fd,2);
1046 697         close(old_fd);
1047 698 }
1048 .fi
1049
1050
1051 .SH "Author"
1052 .PP
1053 Generated automatically by Doxygen for InspIRCd from the source code.