docs/man/man3/Server.3

   1 .TH "Server" 3 "14 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 .ti -1c
 215 .RI "virtual bool \fBIsValidMask\fP (std::string mask)"
 216 .br
 217 .RI "\fIReturns true if a nick!ident string is correctly formatted, false if otherwise. \fP"
 218 .in -1c
 219 .SH "Detailed Description"
 220 .PP
 221 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.
 222
 223 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 224 .PP
 225 Definition at line 437 of file modules.h.
 226 .SH "Constructor & Destructor Documentation"
 227 .PP
 228 .SS "Server::Server ()"
 229 .PP
 230 Default constructor. Creates a Server object.Definition at line 345 of file modules.cpp.
 231 .PP
 232 .nf
 233 346 {
 234 347 }
 235 .fi
 236 .SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
 237 .PP
 238 Default destructor. Destroys a Server object.Definition at line 349 of file modules.cpp.
 239 .PP
 240 .nf
 241 350 {
 242 351 }
 243 .fi
 244 .SH "Member Function Documentation"
 245 .PP
 246 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP"
 247 .PP
 248 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:
 249 .PP
 250 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 251 .PP
 252 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 426 of file modules.cpp.
 253 .PP
 254 References createcommand().
 255 .PP
 256 .nf
 257 427 {
 258 428         createcommand(cmd,f,flags,minparams,source);
 259 429 }
 260 .fi
 261 .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 262 .PP
 263 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 644 of file modules.cpp.
 264 .PP
 265 References add_eline(), and duration().
 266 .PP
 267 .nf
 268 645 {
 269 646         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 270 647 }
 271 .fi
 272 .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
 273 .PP
 274 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:
 275 .PP
 276 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
 277 .PP
 278 (2) They always take exactly one parameter when being added or removed
 279 .PP
 280 (3) They can be set multiple times, usually on users in channels
 281 .PP
 282 (4) The mode and its parameter are NOT stored in the channels modes structure
 283 .PP
 284 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 571 of file modules.cpp.
 285 .PP
 286 References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 287 .PP
 288 .nf
 289 572 {
 290 573         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
 291 574         if (res)
 292 575                 ModeMakeList(modechar);
 293 576         return res;
 294 577 }
 295 .fi
 296 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 297 .PP
 298 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 551 of file modules.cpp.
 299 .PP
 300 References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 301 .PP
 302 .nf
 303 552 {
 304 553         if (type == MT_SERVER)
 305 554         {
 306 555                 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 307 556                 return false;
 308 557         }
 309 558         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 310 559         {
 311 560                 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 312 561                 return false;
 313 562         }
 314 563         if ((params_when_on>1) || (params_when_off>1))
 315 564         {
 316 565                 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 317 566                 return false;
 318 567         }
 319 568         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 320 569 }
 321 .fi
 322 .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 323 .PP
 324 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 624 of file modules.cpp.
 325 .PP
 326 References add_gline(), and duration().
 327 .PP
 328 .nf
 329 625 {
 330 626         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 331 627 }
 332 .fi
 333 .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 334 .PP
 335 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 639 of file modules.cpp.
 336 .PP
 337 References add_kline(), and duration().
 338 .PP
 339 .nf
 340 640 {
 341 641         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 342 642 }
 343 .fi
 344 .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
 345 .PP
 346 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 629 of file modules.cpp.
 347 .PP
 348 References add_qline(), and duration().
 349 .PP
 350 .nf
 351 630 {
 352 631         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
 353 632 }
 354 .fi
 355 .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
 356 .PP
 357 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 634 of file modules.cpp.
 358 .PP
 359 References add_zline(), and duration().
 360 .PP
 361 .nf
 362 635 {
 363 636         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
 364 637 }
 365 .fi
 366 .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
 367 .PP
 368 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 674 of file modules.cpp.
 369 .PP
 370 References duration().
 371 .PP
 372 .nf
 373 675 {
 374 676         return duration(delta.c_str());
 375 677 }
 376 .fi
 377 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 378 .PP
 379 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
 380 .br
 381 ) 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 416 of file modules.cpp.
 382 .PP
 383 .nf
 384 417 {
 385 418         call_handler(commandname.c_str(),parameters,pcnt,user);
 386 419 }
 387 .fi
 388 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 389 .PP
 390 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 504 of file modules.cpp.
 391 .PP
 392 References ChangeName().
 393 .PP
 394 .nf
 395 505 {
 396 506         ChangeName(user,gecos.c_str());
 397 507 }
 398 .fi
 399 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 400 .PP
 401 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 499 of file modules.cpp.
 402 .PP
 403 References ChangeDisplayedHost().
 404 .PP
 405 .nf
 406 500 {
 407 501         ChangeDisplayedHost(user,host.c_str());
 408 502 }
 409 .fi
 410 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 411 .PP
 412 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 400 of file modules.cpp.
 413 .PP
 414 .nf
 415 401 {
 416 402         force_nickchange(user,nickname.c_str());
 417 403 }
 418 .fi
 419 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 420 .PP
 421 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 524 of file modules.cpp.
 422 .PP
 423 References cmode().
 424 .PP
 425 .nf
 426 525 {
 427 526         return cmode(User,Chan);
 428 527 }
 429 .fi
 430 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 431 .PP
 432 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 477 of file modules.cpp.
 433 .PP
 434 References common_channels().
 435 .PP
 436 .nf
 437 478 {
 438 479         return (common_channels(u1,u2) != 0);
 439 480 }
 440 .fi
 441 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 442 .PP
 443 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 579 of file modules.cpp.
 444 .PP
 445 .nf
 446 580 {
 447 581         return usercount(c);
 448 582 }
 449 .fi
 450 .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
 451 .PP
 452 Deletes a local E-Line. Definition at line 669 of file modules.cpp.
 453 .PP
 454 References del_eline().
 455 .PP
 456 .nf
 457 670 {
 458 671         del_eline(hostmask.c_str());
 459 672 }
 460 .fi
 461 .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
 462 .PP
 463 Deletes a G-Line from all servers on the mesh. Definition at line 649 of file modules.cpp.
 464 .PP
 465 References del_gline().
 466 .PP
 467 .nf
 468 650 {
 469 651         del_gline(hostmask.c_str());
 470 652 }
 471 .fi
 472 .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
 473 .PP
 474 Deletes a local K-Line. Definition at line 664 of file modules.cpp.
 475 .PP
 476 References del_kline().
 477 .PP
 478 .nf
 479 665 {
 480 666         del_kline(hostmask.c_str());
 481 667 }
 482 .fi
 483 .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
 484 .PP
 485 Deletes a Q-Line from all servers on the mesh. Definition at line 654 of file modules.cpp.
 486 .PP
 487 References del_qline().
 488 .PP
 489 .nf
 490 655 {
 491 656         del_qline(nickname.c_str());
 492 657 }
 493 .fi
 494 .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
 495 .PP
 496 Deletes a Z-Line from all servers on the mesh. Definition at line 659 of file modules.cpp.
 497 .PP
 498 References del_zline().
 499 .PP
 500 .nf
 501 660 {
 502 661         del_zline(ipaddr.c_str());
 503 662 }
 504 .fi
 505 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 506 .PP
 507 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 519 of file modules.cpp.
 508 .PP
 509 .nf
 510 520 {
 511 521         return FindChan(channel.c_str());
 512 522 }
 513 .fi
 514 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 515 .PP
 516 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 514 of file modules.cpp.
 517 .PP
 518 .nf
 519 515 {
 520 516         return Find(nick);
 521 517 }
 522 .fi
 523 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 524 .PP
 525 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 544 of file modules.cpp.
 526 .PP
 527 .nf
 528 545 {
 529 546         return Admin(getadminname(),getadminemail(),getadminnick());
 530 547 }
 531 .fi
 532 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 533 .PP
 534 Returns the network name, global to all linked servers. Definition at line 539 of file modules.cpp.
 535 .PP
 536 .nf
 537 540 {
 538 541         return getnetworkname();
 539 542 }
 540 .fi
 541 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 542 .PP
 543 Returns the server name of the server where the module is loaded. Definition at line 534 of file modules.cpp.
 544 .PP
 545 .nf
 546 535 {
 547 536         return getservername();
 548 537 }
 549 .fi
 550 .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
 551 .PP
 552 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 381 of file modules.cpp.
 553 .PP
 554 References chanuserlist, clientlist, has_channel(), and isnick().
 555 .PP
 556 .nf
 557 382 {
 558 383         chanuserlist userl;
 559 384         userl.clear();
 560 385         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 561 386         {
 562 387                 if (i->second)
 563 388                 {
 564 389                         if (has_channel(i->second,chan))
 565 390                         {
 566 391                                 if (isnick(i->second->nick))
 567 392                                 {
 568 393                                         userl.push_back(i->second);
 569 394                                 }
 570 395                         }
 571 396                 }
 572 397         }
 573 398         return userl;
 574 399 }
 575 .fi
 576 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 577 .PP
 578 Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 509 of file modules.cpp.
 579 .PP
 580 References isnick().
 581 .PP
 582 .nf
 583 510 {
 584 511         return (isnick(nick.c_str()) != 0);
 585 512 }
 586 .fi
 587 .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 588 .PP
 589 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 529 of file modules.cpp.
 590 .PP
 591 References has_channel().
 592 .PP
 593 .nf
 594 530 {
 595 531         return has_channel(User,Chan);
 596 532 }
 597 .fi
 598 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 599 .PP
 600 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 411 of file modules.cpp.
 601 .PP
 602 References is_uline().
 603 .PP
 604 .nf
 605 412 {
 606 413         return is_uline(server.c_str());
 607 414 }
 608 .fi
 609 .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP"
 610 .PP
 611 Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 679 of file modules.cpp.
 612 .PP
 613 .nf
 614 680 {
 615 681         const char* dest = mask.c_str();
 616 682         if (strchr(dest,'!')==0)
 617 683                 return false;
 618 684         if (strchr(dest,'@')==0)
 619 685                 return false;
 620 686         for (int i = 0; i < strlen(dest); i++)
 621 687                 if (dest[i] < 32)
 622 688                         return false;
 623 689         for (int i = 0; i < strlen(dest); i++)
 624 690                 if (dest[i] > 126)
 625 691                         return false;
 626 692         int c = 0;
 627 693         for (int i = 0; i < strlen(dest); i++)
 628 694                 if (dest[i] == '!')
 629 695                         c++;
 630 696         if (c>1)
 631 697                 return false;
 632 698         c = 0;
 633 699         for (int i = 0; i < strlen(dest); i++)
 634 700                 if (dest[i] == '@')
 635 701                         c++;
 636 702         if (c>1)
 637 703                 return false;
 638 704
 639 705         return true;
 640 706 }
 641 .fi
 642 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 643 .PP
 644 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 371 of file modules.cpp.
 645 .PP
 646 .nf
 647 372 {
 648 373         return add_channel(user,cname.c_str(),key.c_str(),true);
 649 374 }
 650 .fi
 651 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 652 .PP
 653 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 421 of file modules.cpp.
 654 .PP
 655 .nf
 656 422 {
 657 423         log(level,'%s',s.c_str());
 658 424 }
 659 .fi
 660 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 661 .PP
 662 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 358 of file modules.cpp.
 663 .PP
 664 .nf
 665 359 {
 666 360         char literal[MAXBUF],pattern[MAXBUF];
 667 361         strlcpy(literal,sliteral.c_str(),MAXBUF);
 668 362         strlcpy(pattern,spattern.c_str(),MAXBUF);
 669 363         return match(literal,pattern);
 670 364 }
 671 .fi
 672 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 673 .PP
 674 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 376 of file modules.cpp.
 675 .PP
 676 .nf
 677 377 {
 678 378         return del_channel(user,cname.c_str(),reason.c_str(),false);
 679 379 }
 680 .fi
 681 .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
 682 .PP
 683 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 594 of file modules.cpp.
 684 .PP
 685 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.
 686 .PP
 687 .nf
 688 595 {
 689 596         zombie->fd = alive->fd;
 690 597         alive->fd = FD_MAGIC_NUMBER;
 691 598         Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
 692 599         kill_link(alive,message.c_str());
 693 600         for (int i = 0; i != MAXCHANS; i++)
 694 601         {
 695 602                 if (zombie->chans[i].channel != NULL)
 696 603                 {
 697 604                         if (zombie->chans[i].channel->name)
 698 605                         {
 699 606                                 chanrec* Ptr = zombie->chans[i].channel;
 700 607                                 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
 701 608                                 if (Ptr->topicset)
 702 609                                 {
 703 610                                         WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
 704 611                                         WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
 705 612                                 }
 706 613                                 userlist(zombie,Ptr);
 707 614                                 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
 708 615                                 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr));
 709 616                                 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created);
 710 617
 711 618                         }
 712 619                 }
 713 620         }
 714 621
 715 622 }
 716 .fi
 717 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 718 .PP
 719 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.
 720 .PP
 721 WARNING!
 722 .PP
 723 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 405 of file modules.cpp.
 724 .PP
 725 References userrec::nick, and send_network_quit().
 726 .PP
 727 .nf
 728 406 {
 729 407         send_network_quit(user->nick,reason.c_str());
 730 408         kill_link(user,reason.c_str());
 731 409 }
 732 .fi
 733 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 734 .PP
 735 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 436 of file modules.cpp.
 736 .PP
 737 .nf
 738 437 {
 739 438         Write(Socket,'%s',s.c_str());
 740 439 }
 741 .fi
 742 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 743 .PP
 744 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 465 of file modules.cpp.
 745 .PP
 746 .nf
 747 466 {
 748 467         if (IncludeSender)
 749 468         {
 750 469                 WriteChannel(Channel,User,'%s',s.c_str());
 751 470         }
 752 471         else
 753 472         {
 754 473                 ChanExceptSender(Channel,User,'%s',s.c_str());
 755 474         }
 756 475 }
 757 .fi
 758 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 759 .PP
 760 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 482 of file modules.cpp.
 761 .PP
 762 .nf
 763 483 {
 764 484         if (IncludeSender)
 765 485         {
 766 486                 WriteCommon(User,'%s',text.c_str());
 767 487         }
 768 488         else
 769 489         {
 770 490                 WriteCommonExcept(User,'%s',text.c_str());
 771 491         }
 772 492 }
 773 .fi
 774 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 775 .PP
 776 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 446 of file modules.cpp.
 777 .PP
 778 .nf
 779 447 {
 780 448         WriteFrom(Socket,User,'%s',s.c_str());
 781 449 }
 782 .fi
 783 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 784 .PP
 785 Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes.
 786 .PP
 787 For example:
 788 .PP
 789 char *modes[3];
 790 .PP
 791 modes[0] = ChannelName;
 792 .PP
 793 modes[1] = '+o';
 794 .PP
 795 modes[2] = user->nick;
 796 .PP
 797 Srv->SendMode(modes,3,user);
 798 .PP
 799 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 431 of file modules.cpp.
 800 .PP
 801 References server_mode().
 802 .PP
 803 .nf
 804 432 {
 805 433         server_mode(parameters,pcnt,user);
 806 434 }
 807 .fi
 808 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 809 .PP
 810 Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 353 of file modules.cpp.
 811 .PP
 812 .nf
 813 354 {
 814 355         WriteOpers('%s',s.c_str());
 815 356 }
 816 .fi
 817 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 818 .PP
 819 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 441 of file modules.cpp.
 820 .PP
 821 .nf
 822 442 {
 823 443         WriteServ(Socket,'%s',s.c_str());
 824 444 }
 825 .fi
 826 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 827 .PP
 828 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:
 829 .PP
 830 :user!ident TEXT
 831 .PP
 832 The format will become:
 833 .PP
 834 :localserver TEXT
 835 .PP
 836 Which is useful for numerics and server notices to single users, etc.Definition at line 451 of file modules.cpp.
 837 .PP
 838 References connection::fd.
 839 .PP
 840 .nf
 841 452 {
 842 453         if (!Source)
 843 454         {
 844 455                 // if source is NULL, then the message originates from the local server
 845 456                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 846 457         }
 847 458         else
 848 459         {
 849 460                 // otherwise it comes from the user specified
 850 461                 WriteTo(Source,Dest,'%s',s.c_str());
 851 462         }
 852 463 }
 853 .fi
 854 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
 855 .PP
 856 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:
 857 .PP
 858 Serv->SendToModeMask('xi', WM_OR, 'm00');
 859 .PP
 860 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 366 of file modules.cpp.
 861 .PP
 862 .nf
 863 367 {
 864 368         WriteMode(modes.c_str(),flags,'%s',text.c_str());
 865 369 }
 866 .fi
 867 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
 868 .PP
 869 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 494 of file modules.cpp.
 870 .PP
 871 .nf
 872 495 {
 873 496         WriteWallOps(User,false,'%s',text.c_str());
 874 497 }
 875 .fi
 876 .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
 877 .PP
 878 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 585 of file modules.cpp.
 879 .PP
 880 References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
 881 .PP
 882 .nf
 883 586 {
 884 587         unsigned int old_fd = user->fd;
 885 588         user->fd = FD_MAGIC_NUMBER;
 886 589         Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
 887 590         close(old_fd);
 888 591         shutdown (old_fd,2);
 889 592 }
 890 .fi
 891
 892
 893 .SH "Author"
 894 .PP
 895 Generated automatically by Doxygen for InspIRCd from the source code.