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;
33 // This #define allows us to call a method in all
34 // loaded modules in a readable simple way, e.g.:
35 // 'FOREACH_MOD OnConnect(user);'
37 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
39 // This define is similar to the one above but returns a result in MOD_RESULT.
40 // The first module to return a nonzero result is the value to be accepted,
41 // and any modules after are ignored.
43 // *********************************************************************************************
45 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
46 for (int i = 0; i <= MODCOUNT; i++) { \
47 int res = modules[i]->x ; \
55 // *********************************************************************************************
57 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
58 extern void server_mode(char **parameters, int pcnt, userrec *user);
60 // class Version holds the version information of a Module, returned
61 // by Module::GetVersion (thanks RD)
63 /** Holds a module's Version information
64 * The four members (set by the constructor only) indicate details as to the version number
65 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
67 class Version : public classbase
70 const int Major, Minor, Revision, Build;
71 Version(int major, int minor, int revision, int build);
75 * This class contains the admin details of the local server. It is constructed by class Server,
76 * and has three read-only values, Name, Email and Nick that contain the specified values for the
77 * server where the module is running.
79 class Admin : public classbase
82 const std::string Name, Email, Nick;
83 Admin(std::string name, std::string email, std::string nick);
86 /** Base class for all InspIRCd modules
87 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
88 * its methods will be called when irc server events occur. class inherited from module must be
89 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
91 class Module : public classbase
95 /** Default constructor
96 * creates a module class
100 /** Default destructor
101 * destroys a module class
105 /** Returns the version number of a Module.
106 * The method should return a Version object with its version information assigned via
109 virtual Version GetVersion();
111 /** Called when a user connects.
112 * The details of the connecting user are available to you in the parameter userrec *user
114 virtual void OnUserConnect(userrec* user);
116 /** Called when a user quits.
117 * The details of the exiting user are available to you in the parameter userrec *user
119 virtual void OnUserQuit(userrec* user);
121 /** Called when a user joins a channel.
122 * The details of the joining user are available to you in the parameter userrec *user,
123 * and the details of the channel they have joined is available in the variable chanrec *channel
125 virtual void OnUserJoin(userrec* user, chanrec* channel);
127 /** Called when a user parts a channel.
128 * The details of the leaving user are available to you in the parameter userrec *user,
129 * and the details of the channel they have left is available in the variable chanrec *channel
131 virtual void OnUserPart(userrec* user, chanrec* channel);
133 /** Called before a packet is transmitted across the irc network between two irc servers.
134 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
135 * This allows you to easily represent it in the correct ways to implement encryption, compression,
136 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
137 * and will be called before ANY other operations within the ircd core program.
139 virtual void OnPacketTransmit(char *p);
141 /** Called after a packet is received from another irc server.
142 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
143 * This allows you to easily represent it in the correct ways to implement encryption, compression,
144 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
145 * and will be called immediately after the packet is received but before any other operations with the
148 virtual void OnPacketReceive(char *p);
150 /** Called on rehash.
151 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
152 * system. You should use it to reload any files so that your module keeps in step with the
153 * rest of the application.
155 virtual void OnRehash();
157 /** Called when a raw command is transmitted or received.
158 * This method is the lowest level of handler available to a module. It will be called with raw
159 * data which is passing through a connected socket. If you wish, you may munge this data by changing
160 * the string parameter "raw". If you do this, after your function exits it will immediately be
161 * cut down to 510 characters plus a carriage return and linefeed.
163 virtual void OnServerRaw(std::string &raw, bool inbound);
165 /** Called whenever an extended mode is to be processed.
166 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
167 * changed. mode_on is set when the mode is being set, in which case params contains a list of
168 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
169 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
170 * was set up with Server::AddExtendedMode
171 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
172 * You must cast this value yourself to make use of it.
174 virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
176 /** Called whenever a user is about to join a channel, before any processing is done.
177 * Returning any nonzero value from this function stops the process immediately, causing no
178 * output to be sent to the user by the core. If you do this you must produce your own numerics,
179 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
183 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
184 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
185 * processing on the actual channel record at this point, however the channel NAME will still be passed in
186 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
188 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
191 /** Called whenever a user opers locally.
192 * The userrec will contain the oper mode 'o' as this function is called after any modifications
193 * are made to the user's structure by the core.
195 virtual void OnOper(userrec* user);
197 /** Called whenever a user types /INFO.
198 * The userrec will contain the information of the user who typed the command. Modules may use this
199 * method to output their own credits in /INFO (which is the ircd's version of an about box).
200 * It is purposefully not possible to modify any info that has already been output, or halt the list.
201 * You must write a 371 numeric to the user, containing your info in the following format:
203 * <nick> :information here
205 virtual void OnInfo(userrec* user);
207 /** Called whenever a /WHOIS is performed on a local user.
208 * The source parameter contains the details of the user who issued the WHOIS command, and
209 * the dest parameter contains the information of the user they are whoising.
211 virtual void OnWhois(userrec* source, userrec* dest);
213 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
214 * Returning any nonzero value from this function stops the process immediately, causing no
215 * output to be sent to the user by the core. If you do this you must produce your own numerics,
216 * notices etc. This is useful for modules which may want to filter or redirect messages.
217 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
218 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
219 * of where the message is destined to be sent.
221 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
223 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
224 * Returning any nonzero value from this function stops the process immediately, causing no
225 * output to be sent to the user by the core. If you do this you must produce your own numerics,
226 * notices etc. This is useful for modules which may want to filter or redirect messages.
227 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
228 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
229 * of where the message is destined to be sent.
231 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
235 /** Allows server output and query functions
236 * This class contains methods which allow a module to query the state of the irc server, and produce
237 * output to users and other servers. All modules should instantiate at least one copy of this class,
238 * and use its member functions to perform their tasks.
240 class Server : public classbase
243 /** Default constructor.
244 * Creates a Server object.
247 /** Default destructor.
248 * Destroys a Server object.
252 /** Sends text to all opers.
253 * This method sends a server notice to all opers with the usermode +s.
255 virtual void SendOpers(std::string s);
256 /** Writes a log string.
257 * This method writes a line of text to the log. If the level given is lower than the
258 * level given in the configuration, this command has no effect.
260 virtual void Log(int level, std::string s);
261 /** Sends a line of text down a TCP/IP socket.
262 * This method writes a line of text to an established socket, cutting it to 510 characters
263 * plus a carriage return and linefeed if required.
265 virtual void Send(int Socket, std::string s);
266 /** Sends text from the server to a socket.
267 * This method writes a line of text to an established socket, with the servername prepended
268 * as used by numerics (see RFC 1459)
270 virtual void SendServ(int Socket, std::string s);
271 /** Sends text from a user to a socket.
272 * This method writes a line of text to an established socket, with the given user's nick/ident
273 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
275 virtual void SendFrom(int Socket, userrec* User, std::string s);
276 /** Sends text from a user to another user.
277 * This method writes a line of text to a user, with a user's nick/ident
278 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
279 * If you specify NULL as the source, then the data will originate from the
280 * local server, e.g. instead of:
282 * :user!ident@host TEXT
284 * The format will become:
288 * Which is useful for numerics and server notices to single users, etc.
290 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
291 /** Sends text from a user to a channel (mulicast).
292 * This method writes a line of text to a channel, with the given user's nick/ident
293 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
294 * IncludeSender flag is set, then the text is also sent back to the user from which
295 * it originated, as seen in MODE (see RFC 1459).
297 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
298 /** Returns true if two users share a common channel.
299 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
302 virtual bool CommonChannels(userrec* u1, userrec* u2);
303 /** Sends text from a user to one or more channels (mulicast).
304 * This method writes a line of text to all users which share a common channel with a given
305 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
306 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
307 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
308 * is only sent to the other recipients, as seen in QUIT.
310 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
311 /** Sends a WALLOPS message.
312 * This method writes a WALLOPS message to all users with the +w flag, originating from the
315 virtual void SendWallops(userrec* User, std::string text);
317 /** Returns true if a nick is valid.
318 * Nicks for unregistered connections will return false.
320 virtual bool IsNick(std::string nick);
321 /** Returns a count of the number of users on a channel.
322 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
324 virtual int CountUsers(chanrec* c);
325 /** Attempts to look up a nick and return a pointer to it.
326 * This function will return NULL if the nick does not exist.
328 virtual userrec* FindNick(std::string nick);
329 /** Attempts to look up a channel and return a pointer to it.
330 * This function will return NULL if the channel does not exist.
332 virtual chanrec* FindChannel(std::string channel);
333 /** Attempts to look up a user's privilages on a channel.
334 * This function will return a string containing either @, %, +, or an empty string,
335 * representing the user's privilages upon the channel you specify.
337 virtual std::string ChanMode(userrec* User, chanrec* Chan);
338 /** Returns the server name of the server where the module is loaded.
340 virtual std::string GetServerName();
341 /** Returns the network name, global to all linked servers.
343 virtual std::string GetNetworkName();
344 /** Returns the information of the server as returned by the /ADMIN command.
345 * See the Admin class for further information of the return value. The members
346 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
347 * server where the module is loaded.
349 virtual Admin GetAdmin();
350 /** Adds an extended mode letter which is parsed by a module
351 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
352 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
353 * indicate wether the mode is a channel mode, a client mode, or a server mode.
354 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
355 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
356 * params_when_on is the number of modes to expect when the mode is turned on
357 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
358 * the params_when_off value has a similar value to params_when_on, except it indicates
359 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
360 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
361 * use this parameter. The function returns false if the mode is unavailable, and will not
362 * attempt to allocate another character, as this will confuse users. This also means that
363 * as only one module can claim a specific mode character, the core does not need to keep track
364 * of which modules own which modes, which speeds up operation of the server. In this version,
365 * a mode can have at most one parameter, attempting to use more parameters will have undefined
368 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
370 /** Adds a command to the command table.
371 * This allows modules to add extra commands into the command table. You must place a function within your
372 * module which is is of type handlerfunc:
374 * typedef void (handlerfunc) (char**, int, userrec*);
376 * void handle_kill(char **parameters, int pcnt, userrec *user)
378 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
379 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
380 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
381 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
382 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
384 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
386 /** Sends a servermode.
387 * you must format the parameters array with the target, modes and parameters for those modes.
393 * modes[0] = ChannelName;
397 * modes[2] = user->nick;
399 * Srv->SendMode(modes,3,user);
401 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
402 * will be sent to the user you provide as the third parameter.
403 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
404 * your server in an unstable state!
407 virtual void SendMode(char **parameters, int pcnt, userrec *user);
409 /** Sends to all users matching a mode mask
410 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
411 * or module provided modes, including ones provided by your own module.
412 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
413 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
414 * for example, if you were to use:
416 * Serv->SendToModeMask("xi", WM_OR, "m00");
418 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
419 * user must have both modes set to receive the message.
421 virtual void SendToModeMask(std::string modes, int flags, std::string text);
423 /** Forces a user to join a channel.
424 * This is similar to svsjoin and can be used to implement redirection, etc.
425 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
426 * On failure, the result is NULL.
428 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
430 /** Forces a user to part a channel.
431 * This is similar to svspart and can be used to implement redirection, etc.
432 * Although the return value of this function is a pointer to a channel record, the returned data is
433 * undefined and should not be read or written to. This behaviour may be changed in a future version.
435 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
437 /** Forces a user nickchange.
438 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
439 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
440 * the error numeric for it.
442 virtual void ChangeUserNick(userrec* user, std::string nickname);
444 /** Forces a user to quit with the specified reason.
445 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
446 * may bypass the quit prefix specified in the config file.
450 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
451 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
452 * action after calling this method is to immediately bail from your handler.
454 virtual void QuitUser(userrec* user, std::string reason);
456 /** Matches text against a glob pattern.
457 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
458 * Returns true if the literal successfully matches the pattern, false if otherwise.
460 virtual bool MatchText(std::string sliteral, std::string spattern);
462 /** Calls the handler for a command, either implemented by the core or by another module.
463 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
464 * KICK etc, or even as a method of callback. By defining command names that are untypeable
465 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
466 * The first parameter to this method is the name of the command handler you wish to call, e.g.
467 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
468 * The second parameter is an array of parameters, and the third parameter is a count of parameters
469 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
470 * functiom will silently ignore it. The final parameter is the user executing the command handler,
471 * used for privilage checks, etc.
473 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
475 /** Change displayed hostname of a user.
476 * You should always call this method to change a user's host rather than writing directly to the
477 * dhost member of userrec, as any change applied via this method will be propogated to any
480 virtual void ChangeHost(userrec* user, std::string host);
482 /** Change GECOS (fullname) of a user.
483 * You should always call this method to change a user's GECOS rather than writing directly to the
484 * fullname member of userrec, as any change applied via this method will be propogated to any
487 virtual void ChangeGECOS(userrec* user, std::string gecos);
490 /** Allows reading of values from configuration files
491 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
492 * a module-specified configuration file. It may either be instantiated with one parameter or none.
493 * Constructing the class using one parameter allows you to specify a path to your own configuration
494 * file, otherwise, inspircd.conf is read.
496 class ConfigReader : public classbase
499 /** The contents of the configuration file
500 * This protected member should never be accessed by a module (and cannot be accessed unless the
501 * core is changed). It will contain a pointer to the configuration file data with unneeded data
502 * (such as comments) stripped from it.
504 std::stringstream *cache;
505 /** Used to store errors
510 /** Default constructor.
511 * This constructor initialises the ConfigReader class to read the inspircd.conf file
512 * as specified when running ./configure.
514 ConfigReader(); // default constructor reads ircd.conf
515 /** Overloaded constructor.
516 * This constructor initialises the ConfigReader class to read a user-specified config file
518 ConfigReader(std::string filename); // read a module-specific config
519 /** Default destructor.
520 * This method destroys the ConfigReader class.
523 /** Retrieves a value from the config file.
524 * This method retrieves a value from the config file. Where multiple copies of the tag
525 * exist in the config file, index indicates which of the values to retrieve.
527 std::string ReadValue(std::string tag, std::string name, int index);
528 /** Counts the number of times a given tag appears in the config file.
529 * This method counts the number of times a tag appears in a config file, for use where
530 * there are several tags of the same kind, e.g. with opers and connect types. It can be
531 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
532 * multiple instance tag.
534 int Enumerate(std::string tag);
535 /** Returns true if a config file is valid.
536 * This method is partially implemented and will only return false if the config
537 * file does not exist or could not be opened.
541 /** Returns the number of items within a tag.
542 * For example if the tag was <test tag="blah" data="foo"> then this
543 * function would return 2. Spaces and newlines both qualify as valid seperators
546 int EnumerateValues(std::string tag, int index);
551 /** Caches a text file into memory and can be used to retrieve lines from it.
552 * This class contains methods for read-only manipulation of a text file in memory.
553 * Either use the constructor type with one parameter to load a file into memory
554 * at construction, or use the LoadFile method to load a file.
556 class FileReader : public classbase
560 /** Default constructor.
561 * This method does not load any file into memory, you must use the LoadFile method
562 * after constructing the class this way.
566 /** Secondary constructor.
567 * This method initialises the class with a file loaded into it ready for GetLine and
568 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
571 FileReader(std::string filename);
573 /** Default destructor.
574 * This deletes the memory allocated to the file.
578 /** Used to load a file.
579 * This method loads a file into the class ready for GetLine and
580 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
583 void LoadFile(std::string filename);
585 /** Returns true if the file exists
586 * This function will return false if the file could not be opened.
590 /** Retrieve one line from the file.
591 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
592 * the index was out of bounds, or the line had no data on it.
594 std::string GetLine(int x);
596 /** Returns the size of the file in lines.
597 * This method returns the number of lines in the read file. If it is 0, no lines have been
598 * read into memory, either because the file is empty or it does not exist, or cannot be
599 * opened due to permission problems.
605 /** Instantiates classes inherited from Module
606 * This class creates a class inherited from type Module, using new. This is to allow for modules
607 * to create many different variants of Module, dependent on architecture, configuration, etc.
608 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
611 class ModuleFactory : public classbase
615 virtual ~ModuleFactory() { }
616 /** Creates a new module.
617 * Your inherited class of ModuleFactory must return a pointer to your Module class
620 virtual Module * CreateModule() = 0;
624 typedef DLLFactory<ModuleFactory> ircd_module;