27 /** Low level definition of a FileReader classes file cache area
29 typedef std::deque<std::string> file_cache;
30 typedef file_cache string_list;
32 // This #define allows us to call a method in all
33 // loaded modules in a readable simple way, e.g.:
34 // 'FOREACH_MOD OnConnect(user);'
36 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
38 // This define is similar to the one above but returns a result in MOD_RESULT.
39 // The first module to return a nonzero result is the value to be accepted,
40 // and any modules after are ignored.
42 // *********************************************************************************************
44 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
45 for (int i = 0; i <= MODCOUNT; i++) { \
46 int res = modules[i]->x ; \
54 // *********************************************************************************************
56 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
57 extern void server_mode(char **parameters, int pcnt, userrec *user);
59 // class Version holds the version information of a Module, returned
60 // by Module::GetVersion (thanks RD)
62 /** Holds a module's Version information
63 * The four members (set by the constructor only) indicate details as to the version number
64 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
66 class Version : public classbase
69 const int Major, Minor, Revision, Build;
70 Version(int major, int minor, int revision, int build);
74 * This class contains the admin details of the local server. It is constructed by class Server,
75 * and has three read-only values, Name, Email and Nick that contain the specified values for the
76 * server where the module is running.
78 class Admin : public classbase
81 const std::string Name, Email, Nick;
82 Admin(std::string name, std::string email, std::string nick);
85 /** Base class for all InspIRCd modules
86 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
87 * its methods will be called when irc server events occur. class inherited from module must be
88 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
90 class Module : public classbase
94 /** Default constructor
95 * creates a module class
99 /** Default destructor
100 * destroys a module class
104 /** Returns the version number of a Module.
105 * The method should return a Version object with its version information assigned via
108 virtual Version GetVersion();
110 /** Called when a user connects.
111 * The details of the connecting user are available to you in the parameter userrec *user
113 virtual void OnUserConnect(userrec* user);
115 /** Called when a user quits.
116 * The details of the exiting user are available to you in the parameter userrec *user
118 virtual void OnUserQuit(userrec* user);
120 /** Called when a user joins a channel.
121 * The details of the joining user are available to you in the parameter userrec *user,
122 * and the details of the channel they have joined is available in the variable chanrec *channel
124 virtual void OnUserJoin(userrec* user, chanrec* channel);
126 /** Called when a user parts a channel.
127 * The details of the leaving user are available to you in the parameter userrec *user,
128 * and the details of the channel they have left is available in the variable chanrec *channel
130 virtual void OnUserPart(userrec* user, chanrec* channel);
132 /** Called before a packet is transmitted across the irc network between two irc servers.
133 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
134 * This allows you to easily represent it in the correct ways to implement encryption, compression,
135 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
136 * and will be called before ANY other operations within the ircd core program.
138 virtual void OnPacketTransmit(char *p);
140 /** Called after a packet is received from another irc server.
141 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
142 * This allows you to easily represent it in the correct ways to implement encryption, compression,
143 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
144 * and will be called immediately after the packet is received but before any other operations with the
147 virtual void OnPacketReceive(char *p);
149 /** Called on rehash.
150 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
151 * system. You should use it to reload any files so that your module keeps in step with the
152 * rest of the application.
154 virtual void OnRehash();
156 /** Called when a raw command is transmitted or received.
157 * This method is the lowest level of handler available to a module. It will be called with raw
158 * data which is passing through a connected socket. If you wish, you may munge this data by changing
159 * the string parameter "raw". If you do this, after your function exits it will immediately be
160 * cut down to 510 characters plus a carriage return and linefeed.
162 virtual void OnServerRaw(std::string &raw, bool inbound);
164 /** Called whenever an extended mode is to be processed.
165 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
166 * changed. mode_on is set when the mode is being set, in which case params contains a list of
167 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
168 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
169 * was set up with Server::AddExtendedMode
170 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
171 * You must cast this value yourself to make use of it.
173 virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
175 /** Called whenever a user is about to join a channel, before any processing is done.
176 * Returning any nonzero value from this function stops the process immediately, causing no
177 * output to be sent to the user by the core. If you do this you must produce your own numerics,
178 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
182 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
183 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
184 * processing on the actual channel record at this point, however the channel NAME will still be passed in
185 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
187 virtual int Module::OnUserPreJoin(userrec* user, chanrec* chan, char* cname);
192 /** Allows server output and query functions
193 * This class contains methods which allow a module to query the state of the irc server, and produce
194 * output to users and other servers. All modules should instantiate at least one copy of this class,
195 * and use its member functions to perform their tasks.
197 class Server : public classbase
200 /** Default constructor.
201 * Creates a Server object.
204 /** Default destructor.
205 * Destroys a Server object.
209 /** Sends text to all opers.
210 * This method sends a server notice to all opers with the usermode +s.
212 virtual void SendOpers(std::string s);
213 /** Writes a log string.
214 * This method writes a line of text to the log. If the level given is lower than the
215 * level given in the configuration, this command has no effect.
217 virtual void Log(int level, std::string s);
218 /** Sends a line of text down a TCP/IP socket.
219 * This method writes a line of text to an established socket, cutting it to 510 characters
220 * plus a carriage return and linefeed if required.
222 virtual void Send(int Socket, std::string s);
223 /** Sends text from the server to a socket.
224 * This method writes a line of text to an established socket, with the servername prepended
225 * as used by numerics (see RFC 1459)
227 virtual void SendServ(int Socket, std::string s);
228 /** Sends text from a user to a socket.
229 * This method writes a line of text to an established socket, with the given user's nick/ident
230 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
232 virtual void SendFrom(int Socket, userrec* User, std::string s);
233 /** Sends text from a user to another user.
234 * This method writes a line of text to a user, with a user's nick/ident
235 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
237 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
238 /** Sends text from a user to a channel (mulicast).
239 * This method writes a line of text to a channel, with the given user's nick/ident
240 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
241 * IncludeSender flag is set, then the text is also sent back to the user from which
242 * it originated, as seen in MODE (see RFC 1459).
244 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
245 /** Returns true if two users share a common channel.
246 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
249 virtual bool CommonChannels(userrec* u1, userrec* u2);
250 /** Sends text from a user to one or more channels (mulicast).
251 * This method writes a line of text to all users which share a common channel with a given
252 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
253 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
254 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
255 * is only sent to the other recipients, as seen in QUIT.
257 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
258 /** Sends a WALLOPS message.
259 * This method writes a WALLOPS message to all users with the +w flag, originating from the
262 virtual void SendWallops(userrec* User, std::string text);
264 /** Returns true if a nick is valid.
265 * Nicks for unregistered connections will return false.
267 virtual bool IsNick(std::string nick);
268 /** Attempts to look up a nick and return a pointer to it.
269 * This function will return NULL if the nick does not exist.
271 virtual userrec* FindNick(std::string nick);
272 /** Attempts to look up a channel and return a pointer to it.
273 * This function will return NULL if the channel does not exist.
275 virtual chanrec* FindChannel(std::string channel);
276 /** Attempts to look up a user's privilages on a channel.
277 * This function will return a string containing either @, %, +, or an empty string,
278 * representing the user's privilages upon the channel you specify.
280 virtual std::string ChanMode(userrec* User, chanrec* Chan);
281 /** Returns the server name of the server where the module is loaded.
283 virtual std::string GetServerName();
284 /** Returns the network name, global to all linked servers.
286 virtual std::string GetNetworkName();
287 /** Returns the information of the server as returned by the /ADMIN command.
288 * See the Admin class for further information of the return value. The members
289 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
290 * server where the module is loaded.
292 virtual Admin GetAdmin();
293 /** Adds an extended mode letter which is parsed by a module
294 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
295 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
296 * indicate wether the mode is a channel mode, a client mode, or a server mode.
297 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
298 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
299 * params_when_on is the number of modes to expect when the mode is turned on
300 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
301 * the params_when_off value has a similar value to params_when_on, except it indicates
302 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
303 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
304 * use this parameter. The function returns false if the mode is unavailable, and will not
305 * attempt to allocate another character, as this will confuse users. This also means that
306 * as only one module can claim a specific mode character, the core does not need to keep track
307 * of which modules own which modes, which speeds up operation of the server. In this version,
308 * a mode can have at most one parameter, attempting to use more parameters will have undefined
311 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
313 /** Adds a command to the command table.
314 * This allows modules to add extra commands into the command table. You must place a function within your
315 * module which is is of type handlerfunc:
317 * typedef void (handlerfunc) (char**, int, userrec*);
319 * void handle_kill(char **parameters, int pcnt, userrec *user)
321 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
322 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
323 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
324 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
325 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
327 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
329 /** Sends a servermode.
330 * you must format the parameters array with the target, modes and parameters for those modes.
336 * modes[0] = ChannelName;
340 * modes[2] = user->nick;
342 * Srv->SendMode(modes,3,user);
344 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
345 * will be sent to the user you provide as the third parameter.
346 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
347 * your server in an unstable state!
350 virtual void SendMode(char **parameters, int pcnt, userrec *user);
353 /** Allows reading of values from configuration files
354 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
355 * a module-specified configuration file. It may either be instantiated with one parameter or none.
356 * Constructing the class using one parameter allows you to specify a path to your own configuration
357 * file, otherwise, inspircd.conf is read.
359 class ConfigReader : public classbase
362 /** The filename of the configuration file, as set by the constructor.
366 /** Default constructor.
367 * This constructor initialises the ConfigReader class to read the inspircd.conf file
368 * as specified when running ./configure.
370 ConfigReader(); // default constructor reads ircd.conf
371 /** Overloaded constructor.
372 * This constructor initialises the ConfigReader class to read a user-specified config file
374 ConfigReader(std::string filename); // read a module-specific config
375 /** Default destructor.
376 * This method destroys the ConfigReader class.
379 /** Retrieves a value from the config file.
380 * This method retrieves a value from the config file. Where multiple copies of the tag
381 * exist in the config file, index indicates which of the values to retrieve.
383 std::string ReadValue(std::string tag, std::string name, int index);
384 /** Counts the number of times a given tag appears in the config file.
385 * This method counts the number of times a tag appears in a config file, for use where
386 * there are several tags of the same kind, e.g. with opers and connect types. It can be
387 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
388 * multiple instance tag.
390 int Enumerate(std::string tag);
391 /** Returns true if a config file is valid.
392 * This method is unimplemented and will always return true.
399 /** Caches a text file into memory and can be used to retrieve lines from it.
400 * This class contains methods for read-only manipulation of a text file in memory.
401 * Either use the constructor type with one parameter to load a file into memory
402 * at construction, or use the LoadFile method to load a file.
404 class FileReader : public classbase
408 /** Default constructor.
409 * This method does not load any file into memory, you must use the LoadFile method
410 * after constructing the class this way.
413 /** Secondary constructor.
414 * This method initialises the class with a file loaded into it ready for GetLine and
415 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
418 FileReader(std::string filename);
419 /** Default destructor.
420 * This deletes the memory allocated to the file.
423 /** Used to load a file.
424 * This method loads a file into the class ready for GetLine and
425 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
428 void LoadFile(std::string filename);
429 /** Retrieve one line from the file.
430 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
431 * the index was out of bounds, or the line had no data on it.
434 std::string GetLine(int x);
435 /** Returns the size of the file in lines.
436 * This method returns the number of lines in the read file. If it is 0, no lines have been
437 * read into memory, either because the file is empty or it does not exist, or cannot be
438 * opened due to permission problems.
444 /** Instantiates classes inherited from Module
445 * This class creates a class inherited from type Module, using new. This is to allow for modules
446 * to create many different variants of Module, dependent on architecture, configuration, etc.
447 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
450 class ModuleFactory : public classbase
454 virtual ~ModuleFactory() { }
455 /** Creates a new module.
456 * Your inherited class of ModuleFactory must return a pointer to your Module class
459 virtual Module * CreateModule() = 0;
463 typedef DLLFactory<ModuleFactory> ircd_module;