docs/man/Module.3

   1 .TH "Module" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Module \- Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
   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 "\fBModule\fP ()"
  20 .br
  21 .RI "\fIDefault constructor creates a module class.\fP"
  22 .ti -1c
  23 .RI "virtual \fB~Module\fP ()"
  24 .br
  25 .RI "\fIDefault destructor destroys a module class.\fP"
  26 .ti -1c
  27 .RI "virtual \fBVersion\fP \fBGetVersion\fP ()"
  28 .br
  29 .RI "\fIReturns the version number of a Module.\fP"
  30 .ti -1c
  31 .RI "virtual void \fBOnUserConnect\fP (\fBuserrec\fP *user)"
  32 .br
  33 .RI "\fICalled when a user connects.\fP"
  34 .ti -1c
  35 .RI "virtual void \fBOnUserQuit\fP (\fBuserrec\fP *user)"
  36 .br
  37 .RI "\fICalled when a user quits.\fP"
  38 .ti -1c
  39 .RI "virtual void \fBOnUserJoin\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel)"
  40 .br
  41 .RI "\fICalled when a user joins a channel.\fP"
  42 .ti -1c
  43 .RI "virtual void \fBOnUserPart\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel)"
  44 .br
  45 .RI "\fICalled when a user parts a channel.\fP"
  46 .ti -1c
  47 .RI "virtual void \fBOnPacketTransmit\fP (char *p)"
  48 .br
  49 .RI "\fICalled before a packet is transmitted across the irc network between two irc servers.\fP"
  50 .ti -1c
  51 .RI "virtual void \fBOnPacketReceive\fP (char *p)"
  52 .br
  53 .RI "\fICalled after a packet is received from another irc server.\fP"
  54 .ti -1c
  55 .RI "virtual void \fBOnRehash\fP ()"
  56 .br
  57 .RI "\fICalled on rehash.\fP"
  58 .ti -1c
  59 .RI "virtual void \fBOnServerRaw\fP (std::string &raw, bool inbound, \fBuserrec\fP *user)"
  60 .br
  61 .RI "\fICalled when a raw command is transmitted or received.\fP"
  62 .ti -1c
  63 .RI "virtual bool \fBOnExtendedMode\fP (\fBuserrec\fP *user, void *target, char modechar, int type, bool mode_on, \fBstring_list\fP &params)"
  64 .br
  65 .RI "\fICalled whenever an extended mode is to be processed.\fP"
  66 .ti -1c
  67 .RI "virtual int \fBOnUserPreJoin\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan, const char *cname)"
  68 .br
  69 .RI "\fICalled whenever a user is about to join a channel, before any processing is done.\fP"
  70 .ti -1c
  71 .RI "virtual void \fBOnOper\fP (\fBuserrec\fP *user)"
  72 .br
  73 .RI "\fICalled whenever a user opers locally.\fP"
  74 .ti -1c
  75 .RI "virtual void \fBOnInfo\fP (\fBuserrec\fP *user)"
  76 .br
  77 .RI "\fICalled whenever a user types /INFO.\fP"
  78 .ti -1c
  79 .RI "virtual void \fBOnWhois\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest)"
  80 .br
  81 .RI "\fICalled whenever a /WHOIS is performed on a local user.\fP"
  82 .ti -1c
  83 .RI "virtual int \fBOnUserPreMessage\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string text)"
  84 .br
  85 .RI "\fICalled whenever a user is about to PRIVMSG A user or a channel, before any processing is done.\fP"
  86 .ti -1c
  87 .RI "virtual int \fBOnUserPreNotice\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string text)"
  88 .br
  89 .RI "\fICalled whenever a user is about to NOTICE A user or a channel, before any processing is done.\fP"
  90 .ti -1c
  91 .RI "virtual int \fBOnUserPreNick\fP (\fBuserrec\fP *user, std::string newnick)"
  92 .br
  93 .RI "\fICalled before any nickchange, local or remote.\fP"
  94 .in -1c
  95 .SH "Detailed Description"
  96 .PP
  97 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  98
  99 All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the \fBModuleFactory\fP class (see relevent section) for the plugin to be initialised.
 100 .PP
 101 Definition at line 92 of file modules.h.
 102 .SH "Constructor & Destructor Documentation"
 103 .PP
 104 .SS "Module::Module ()"
 105 .PP
 106 Default constructor creates a module class.Definition at line 111 of file modules.cpp.
 107 .PP
 108 .nf
 109 111 { }
 110 .fi
 111 .SS "Module::~Module ()\fC [virtual]\fP"
 112 .PP
 113 Default destructor destroys a module class.Definition at line 112 of file modules.cpp.
 114 .PP
 115 .nf
 116 112 { }
 117 .fi
 118 .SH "Member Function Documentation"
 119 .PP
 120 .SS "\fBVersion\fP Module::GetVersion ()\fC [virtual]\fP"
 121 .PP
 122 Returns the version number of a Module.The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 123 of file modules.cpp.
 123 .PP
 124 .nf
 125 123 { return Version(1,0,0,0); }
 126 .fi
 127 .SS "bool Module::OnExtendedMode (\fBuserrec\fP * user, void * target, char modechar, int type, bool mode_on, \fBstring_list\fP & params)\fC [virtual]\fP"
 128 .PP
 129 Called whenever an extended mode is to be processed.The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 122 of file modules.cpp.
 130 .PP
 131 .nf
 132 122 { return false; }
 133 .fi
 134 .SS "void Module::OnInfo (\fBuserrec\fP * user)\fC [virtual]\fP"
 135 .PP
 136 Called whenever a user types /INFO.The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:
 137 .PP
 138 :information hereDefinition at line 125 of file modules.cpp.
 139 .PP
 140 .nf
 141 125 { };
 142 .fi
 143 .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP"
 144 .PP
 145 Called whenever a user opers locally.The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 124 of file modules.cpp.
 146 .PP
 147 .nf
 148 124 { };
 149 .fi
 150 .SS "void Module::OnPacketReceive (char * p)\fC [virtual]\fP"
 151 .PP
 152 Called after a packet is received from another irc server.The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 118 of file modules.cpp.
 153 .PP
 154 .nf
 155 118 { }
 156 .fi
 157 .SS "void Module::OnPacketTransmit (char * p)\fC [virtual]\fP"
 158 .PP
 159 Called before a packet is transmitted across the irc network between two irc servers.The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 117 of file modules.cpp.
 160 .PP
 161 .nf
 162 117 { }
 163 .fi
 164 .SS "void Module::OnRehash ()\fC [virtual]\fP"
 165 .PP
 166 Called on rehash.This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 119 of file modules.cpp.
 167 .PP
 168 .nf
 169 119 { }
 170 .fi
 171 .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP"
 172 .PP
 173 Called when a raw command is transmitted or received.This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 120 of file modules.cpp.
 174 .PP
 175 .nf
 176 120 { }
 177 .fi
 178 .SS "void Module::OnUserConnect (\fBuserrec\fP * user)\fC [virtual]\fP"
 179 .PP
 180 Called when a user connects.The details of the connecting user are available to you in the parameter userrec *userDefinition at line 113 of file modules.cpp.
 181 .PP
 182 .nf
 183 113 { }
 184 .fi
 185 .SS "void Module::OnUserJoin (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP"
 186 .PP
 187 Called when a user joins a channel.The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 115 of file modules.cpp.
 188 .PP
 189 .nf
 190 115 { }
 191 .fi
 192 .SS "void Module::OnUserPart (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP"
 193 .PP
 194 Called when a user parts a channel.The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 116 of file modules.cpp.
 195 .PP
 196 .nf
 197 116 { }
 198 .fi
 199 .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP"
 200 .PP
 201 Called whenever a user is about to join a channel, before any processing is done.Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
 202 .PP
 203 IMPORTANT NOTE!
 204 .PP
 205 If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 121 of file modules.cpp.
 206 .PP
 207 .nf
 208 121 { return 0; }
 209 .fi
 210 .SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string text)\fC [virtual]\fP"
 211 .PP
 212 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 127 of file modules.cpp.
 213 .PP
 214 .nf
 215 127 { return 0; };
 216 .fi
 217 .SS "int Module::OnUserPreNick (\fBuserrec\fP * user, std::string newnick)\fC [virtual]\fP"
 218 .PP
 219 Called before any nickchange, local or remote.This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 129 of file modules.cpp.
 220 .PP
 221 .nf
 222 129 { return 0; };
 223 .fi
 224 .SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string text)\fC [virtual]\fP"
 225 .PP
 226 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 128 of file modules.cpp.
 227 .PP
 228 .nf
 229 128 { return 0; };
 230 .fi
 231 .SS "void Module::OnUserQuit (\fBuserrec\fP * user)\fC [virtual]\fP"
 232 .PP
 233 Called when a user quits.The details of the exiting user are available to you in the parameter userrec *userDefinition at line 114 of file modules.cpp.
 234 .PP
 235 .nf
 236 114 { }
 237 .fi
 238 .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP"
 239 .PP
 240 Called whenever a /WHOIS is performed on a local user.The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 126 of file modules.cpp.
 241 .PP
 242 .nf
 243 126 { };
 244 .fi
 245
 246
 247 .SH "Author"
 248 .PP
 249 Generated automatically by Doxygen for InspIRCd from the source code.