28 /** Low level definition of a FileReader classes file cache area
30 typedef std::deque<std::string> file_cache;
31 typedef file_cache string_list;
34 // This #define allows us to call a method in all
35 // loaded modules in a readable simple way, e.g.:
36 // 'FOREACH_MOD OnConnect(user);'
38 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
40 // This define is similar to the one above but returns a result in MOD_RESULT.
41 // The first module to return a nonzero result is the value to be accepted,
42 // and any modules after are ignored.
44 // *********************************************************************************************
46 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
47 for (int i = 0; i <= MODCOUNT; i++) { \
48 int res = modules[i]->x ; \
56 // *********************************************************************************************
58 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
59 extern void server_mode(char **parameters, int pcnt, userrec *user);
61 // class Version holds the version information of a Module, returned
62 // by Module::GetVersion (thanks RD)
64 /** Holds a module's Version information
65 * The four members (set by the constructor only) indicate details as to the version number
66 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
68 class Version : public classbase
71 const int Major, Minor, Revision, Build;
72 Version(int major, int minor, int revision, int build);
76 * This class contains the admin details of the local server. It is constructed by class Server,
77 * and has three read-only values, Name, Email and Nick that contain the specified values for the
78 * server where the module is running.
80 class Admin : public classbase
83 const std::string Name, Email, Nick;
84 Admin(std::string name, std::string email, std::string nick);
87 /** Base class for all InspIRCd modules
88 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
89 * its methods will be called when irc server events occur. class inherited from module must be
90 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
92 class Module : public classbase
96 /** Default constructor
97 * creates a module class
101 /** Default destructor
102 * destroys a module class
106 /** Returns the version number of a Module.
107 * The method should return a Version object with its version information assigned via
110 virtual Version GetVersion();
112 /** Called when a user connects.
113 * The details of the connecting user are available to you in the parameter userrec *user
115 virtual void OnUserConnect(userrec* user);
117 /** Called when a user quits.
118 * The details of the exiting user are available to you in the parameter userrec *user
120 virtual void OnUserQuit(userrec* user);
122 /** Called when a user joins a channel.
123 * The details of the joining user are available to you in the parameter userrec *user,
124 * and the details of the channel they have joined is available in the variable chanrec *channel
126 virtual void OnUserJoin(userrec* user, chanrec* channel);
128 /** Called when a user parts a channel.
129 * The details of the leaving user are available to you in the parameter userrec *user,
130 * and the details of the channel they have left is available in the variable chanrec *channel
132 virtual void OnUserPart(userrec* user, chanrec* channel);
134 /** Called before a packet is transmitted across the irc network between two irc servers.
135 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
136 * This allows you to easily represent it in the correct ways to implement encryption, compression,
137 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
138 * and will be called before ANY other operations within the ircd core program.
140 virtual void OnPacketTransmit(char *p);
142 /** Called after a packet is received from another irc server.
143 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
144 * This allows you to easily represent it in the correct ways to implement encryption, compression,
145 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
146 * and will be called immediately after the packet is received but before any other operations with the
149 virtual void OnPacketReceive(char *p);
151 /** Called on rehash.
152 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
153 * system. You should use it to reload any files so that your module keeps in step with the
154 * rest of the application.
156 virtual void OnRehash();
158 /** Called when a raw command is transmitted or received.
159 * This method is the lowest level of handler available to a module. It will be called with raw
160 * data which is passing through a connected socket. If you wish, you may munge this data by changing
161 * the string parameter "raw". If you do this, after your function exits it will immediately be
162 * cut down to 510 characters plus a carriage return and linefeed.
164 virtual void OnServerRaw(std::string &raw, bool inbound);
166 /** Called whenever an extended mode is to be processed.
167 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
168 * changed. mode_on is set when the mode is being set, in which case params contains a list of
169 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
170 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
171 * was set up with Server::AddExtendedMode
172 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
173 * You must cast this value yourself to make use of it.
175 virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
177 /** Called whenever a user is about to join a channel, before any processing is done.
178 * Returning any nonzero value from this function stops the process immediately, causing no
179 * output to be sent to the user by the core. If you do this you must produce your own numerics,
180 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
184 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
185 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
186 * processing on the actual channel record at this point, however the channel NAME will still be passed in
187 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
189 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
192 /** Called whenever a user opers locally.
193 * The userrec will contain the oper mode 'o' as this function is called after any modifications
194 * are made to the user's structure by the core.
196 virtual void OnOper(userrec* user);
198 /** Called whenever a user types /INFO.
199 * The userrec will contain the information of the user who typed the command. Modules may use this
200 * method to output their own credits in /INFO (which is the ircd's version of an about box).
201 * It is purposefully not possible to modify any info that has already been output, or halt the list.
202 * You must write a 371 numeric to the user, containing your info in the following format:
204 * <nick> :information here
206 virtual void OnInfo(userrec* user);
208 /** Called whenever a /WHOIS is performed on a local user.
209 * The source parameter contains the details of the user who issued the WHOIS command, and
210 * the dest parameter contains the information of the user they are whoising.
212 virtual void OnWhois(userrec* source, userrec* dest);
214 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
215 * Returning any nonzero value from this function stops the process immediately, causing no
216 * output to be sent to the user by the core. If you do this you must produce your own numerics,
217 * notices etc. This is useful for modules which may want to filter or redirect messages.
218 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
219 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
220 * of where the message is destined to be sent.
222 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
224 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
225 * Returning any nonzero value from this function stops the process immediately, causing no
226 * output to be sent to the user by the core. If you do this you must produce your own numerics,
227 * notices etc. This is useful for modules which may want to filter or redirect messages.
228 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
229 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
230 * of where the message is destined to be sent.
232 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
236 /** Allows server output and query functions
237 * This class contains methods which allow a module to query the state of the irc server, and produce
238 * output to users and other servers. All modules should instantiate at least one copy of this class,
239 * and use its member functions to perform their tasks.
241 class Server : public classbase
244 /** Default constructor.
245 * Creates a Server object.
248 /** Default destructor.
249 * Destroys a Server object.
253 /** Sends text to all opers.
254 * This method sends a server notice to all opers with the usermode +s.
256 virtual void SendOpers(std::string s);
257 /** Writes a log string.
258 * This method writes a line of text to the log. If the level given is lower than the
259 * level given in the configuration, this command has no effect.
261 virtual void Log(int level, std::string s);
262 /** Sends a line of text down a TCP/IP socket.
263 * This method writes a line of text to an established socket, cutting it to 510 characters
264 * plus a carriage return and linefeed if required.
266 virtual void Send(int Socket, std::string s);
267 /** Sends text from the server to a socket.
268 * This method writes a line of text to an established socket, with the servername prepended
269 * as used by numerics (see RFC 1459)
271 virtual void SendServ(int Socket, std::string s);
272 /** Sends text from a user to a socket.
273 * This method writes a line of text to an established socket, with the given user's nick/ident
274 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
276 virtual void SendFrom(int Socket, userrec* User, std::string s);
277 /** Sends text from a user to another user.
278 * This method writes a line of text to a user, with a user's nick/ident
279 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
280 * If you specify NULL as the source, then the data will originate from the
281 * local server, e.g. instead of:
283 * :user!ident@host TEXT
285 * The format will become:
289 * Which is useful for numerics and server notices to single users, etc.
291 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
292 /** Sends text from a user to a channel (mulicast).
293 * This method writes a line of text to a channel, with the given user's nick/ident
294 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
295 * IncludeSender flag is set, then the text is also sent back to the user from which
296 * it originated, as seen in MODE (see RFC 1459).
298 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
299 /** Returns true if two users share a common channel.
300 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
303 virtual bool CommonChannels(userrec* u1, userrec* u2);
304 /** Sends text from a user to one or more channels (mulicast).
305 * This method writes a line of text to all users which share a common channel with a given
306 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
307 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
308 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
309 * is only sent to the other recipients, as seen in QUIT.
311 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
312 /** Sends a WALLOPS message.
313 * This method writes a WALLOPS message to all users with the +w flag, originating from the
316 virtual void SendWallops(userrec* User, std::string text);
318 /** Returns true if a nick is valid.
319 * Nicks for unregistered connections will return false.
321 virtual bool IsNick(std::string nick);
322 /** Returns a count of the number of users on a channel.
323 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
325 virtual int CountUsers(chanrec* c);
326 /** Attempts to look up a nick and return a pointer to it.
327 * This function will return NULL if the nick does not exist.
329 virtual userrec* FindNick(std::string nick);
330 /** Attempts to look up a channel and return a pointer to it.
331 * This function will return NULL if the channel does not exist.
333 virtual chanrec* FindChannel(std::string channel);
334 /** Attempts to look up a user's privilages on a channel.
335 * This function will return a string containing either @, %, +, or an empty string,
336 * representing the user's privilages upon the channel you specify.
338 virtual std::string ChanMode(userrec* User, chanrec* Chan);
339 /** Returns the server name of the server where the module is loaded.
341 virtual std::string GetServerName();
342 /** Returns the network name, global to all linked servers.
344 virtual std::string GetNetworkName();
345 /** Returns the information of the server as returned by the /ADMIN command.
346 * See the Admin class for further information of the return value. The members
347 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
348 * server where the module is loaded.
350 virtual Admin GetAdmin();
351 /** Adds an extended mode letter which is parsed by a module
352 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
353 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
354 * indicate wether the mode is a channel mode, a client mode, or a server mode.
355 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
356 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
357 * params_when_on is the number of modes to expect when the mode is turned on
358 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
359 * the params_when_off value has a similar value to params_when_on, except it indicates
360 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
361 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
362 * use this parameter. The function returns false if the mode is unavailable, and will not
363 * attempt to allocate another character, as this will confuse users. This also means that
364 * as only one module can claim a specific mode character, the core does not need to keep track
365 * of which modules own which modes, which speeds up operation of the server. In this version,
366 * a mode can have at most one parameter, attempting to use more parameters will have undefined
369 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
371 /** Adds a command to the command table.
372 * This allows modules to add extra commands into the command table. You must place a function within your
373 * module which is is of type handlerfunc:
375 * typedef void (handlerfunc) (char**, int, userrec*);
377 * void handle_kill(char **parameters, int pcnt, userrec *user)
379 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
380 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
381 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
382 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
383 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
385 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
387 /** Sends a servermode.
388 * you must format the parameters array with the target, modes and parameters for those modes.
394 * modes[0] = ChannelName;
398 * modes[2] = user->nick;
400 * Srv->SendMode(modes,3,user);
402 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
403 * will be sent to the user you provide as the third parameter.
404 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
405 * your server in an unstable state!
408 virtual void SendMode(char **parameters, int pcnt, userrec *user);
410 /** Sends to all users matching a mode mask
411 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
412 * or module provided modes, including ones provided by your own module.
413 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
414 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
415 * for example, if you were to use:
417 * Serv->SendToModeMask("xi", WM_OR, "m00");
419 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
420 * user must have both modes set to receive the message.
422 virtual void SendToModeMask(std::string modes, int flags, std::string text);
424 /** Forces a user to join a channel.
425 * This is similar to svsjoin and can be used to implement redirection, etc.
426 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
427 * On failure, the result is NULL.
429 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
431 /** Forces a user to part a channel.
432 * This is similar to svspart and can be used to implement redirection, etc.
433 * Although the return value of this function is a pointer to a channel record, the returned data is
434 * undefined and should not be read or written to. This behaviour may be changed in a future version.
436 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
438 /** Forces a user nickchange.
439 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
440 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
441 * the error numeric for it.
443 virtual void ChangeUserNick(userrec* user, std::string nickname);
445 /** Forces a user to quit with the specified reason.
446 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
447 * may bypass the quit prefix specified in the config file.
451 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
452 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
453 * action after calling this method is to immediately bail from your handler.
455 virtual void QuitUser(userrec* user, std::string reason);
457 /** Matches text against a glob pattern.
458 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
459 * Returns true if the literal successfully matches the pattern, false if otherwise.
461 virtual bool MatchText(std::string sliteral, std::string spattern);
463 /** Calls the handler for a command, either implemented by the core or by another module.
464 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
465 * KICK etc, or even as a method of callback. By defining command names that are untypeable
466 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
467 * The first parameter to this method is the name of the command handler you wish to call, e.g.
468 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
469 * The second parameter is an array of parameters, and the third parameter is a count of parameters
470 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
471 * functiom will silently ignore it. The final parameter is the user executing the command handler,
472 * used for privilage checks, etc.
474 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
476 /** Change displayed hostname of a user.
477 * You should always call this method to change a user's host rather than writing directly to the
478 * dhost member of userrec, as any change applied via this method will be propogated to any
481 virtual void ChangeHost(userrec* user, std::string host);
483 /** Change GECOS (fullname) of a user.
484 * You should always call this method to change a user's GECOS rather than writing directly to the
485 * fullname member of userrec, as any change applied via this method will be propogated to any
488 virtual void ChangeGECOS(userrec* user, std::string gecos);
491 /** Allows reading of values from configuration files
492 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
493 * a module-specified configuration file. It may either be instantiated with one parameter or none.
494 * Constructing the class using one parameter allows you to specify a path to your own configuration
495 * file, otherwise, inspircd.conf is read.
497 class ConfigReader : public classbase
500 /** The contents of the configuration file
501 * This protected member should never be accessed by a module (and cannot be accessed unless the
502 * core is changed). It will contain a pointer to the configuration file data with unneeded data
503 * (such as comments) stripped from it.
505 std::stringstream *cache;
506 /** Used to store errors
511 /** Default constructor.
512 * This constructor initialises the ConfigReader class to read the inspircd.conf file
513 * as specified when running ./configure.
515 ConfigReader(); // default constructor reads ircd.conf
516 /** Overloaded constructor.
517 * This constructor initialises the ConfigReader class to read a user-specified config file
519 ConfigReader(std::string filename); // read a module-specific config
520 /** Default destructor.
521 * This method destroys the ConfigReader class.
524 /** Retrieves a value from the config file.
525 * This method retrieves a value from the config file. Where multiple copies of the tag
526 * exist in the config file, index indicates which of the values to retrieve.
528 std::string ReadValue(std::string tag, std::string name, int index);
529 /** Counts the number of times a given tag appears in the config file.
530 * This method counts the number of times a tag appears in a config file, for use where
531 * there are several tags of the same kind, e.g. with opers and connect types. It can be
532 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
533 * multiple instance tag.
535 int Enumerate(std::string tag);
536 /** Returns true if a config file is valid.
537 * This method is partially implemented and will only return false if the config
538 * file does not exist or could not be opened.
542 /** Returns the number of items within a tag.
543 * For example if the tag was <test tag="blah" data="foo"> then this
544 * function would return 2. Spaces and newlines both qualify as valid seperators
547 int EnumerateValues(std::string tag, int index);
552 /** Caches a text file into memory and can be used to retrieve lines from it.
553 * This class contains methods for read-only manipulation of a text file in memory.
554 * Either use the constructor type with one parameter to load a file into memory
555 * at construction, or use the LoadFile method to load a file.
557 class FileReader : public classbase
561 /** Default constructor.
562 * This method does not load any file into memory, you must use the LoadFile method
563 * after constructing the class this way.
567 /** Secondary constructor.
568 * This method initialises the class with a file loaded into it ready for GetLine and
569 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
572 FileReader(std::string filename);
574 /** Default destructor.
575 * This deletes the memory allocated to the file.
579 /** Used to load a file.
580 * This method loads a file into the class ready for GetLine and
581 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
584 void LoadFile(std::string filename);
586 /** Returns true if the file exists
587 * This function will return false if the file could not be opened.
591 /** Retrieve one line from the file.
592 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
593 * the index was out of bounds, or the line had no data on it.
595 std::string GetLine(int x);
597 /** Returns the size of the file in lines.
598 * This method returns the number of lines in the read file. If it is 0, no lines have been
599 * read into memory, either because the file is empty or it does not exist, or cannot be
600 * opened due to permission problems.
606 /** Instantiates classes inherited from Module
607 * This class creates a class inherited from type Module, using new. This is to allow for modules
608 * to create many different variants of Module, dependent on architecture, configuration, etc.
609 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
612 class ModuleFactory : public classbase
616 virtual ~ModuleFactory() { }
617 /** Creates a new module.
618 * Your inherited class of ModuleFactory must return a pointer to your Module class
621 virtual Module * CreateModule() = 0;
625 typedef DLLFactory<ModuleFactory> ircd_module;