1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
29 // used with OnExtendedMode() method of modules
35 // used with OnAccessCheck() method of modules
37 #define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded)
38 #define ACR_DENY 1 // deny the action
39 #define ACR_ALLOW 2 // allow the action
41 #define AC_KICK 0 // a user is being kicked
42 #define AC_DEOP 1 // a user is being deopped
43 #define AC_OP 2 // a user is being opped
44 #define AC_VOICE 3 // a user is being voiced
45 #define AC_DEVOICE 4 // a user is being devoiced
46 #define AC_HALFOP 5 // a user is being halfopped
47 #define AC_DEHALFOP 6 // a user is being dehalfopped
48 #define AC_INVITE 7 // a user is being invited
49 #define AC_GENERAL_MODE 8 // a user channel mode is being changed
51 // used to define a set of behavior bits for a module
53 #define VF_STATIC 1 // module is static, cannot be /unloadmodule'd
54 #define VF_VENDOR 2 // module is a vendor module (came in the original tarball, not 3rd party)
55 #define VF_SERVICEPROVIDER 4 // module provides a service to other modules (can be a dependency)
56 #define VF_COMMON 8 // module needs to be common on all servers in a mesh to link
65 /** Low level definition of a FileReader classes file cache area
67 typedef std::deque<std::string> file_cache;
68 typedef file_cache string_list;
70 /** Holds a list of users in a channel
72 typedef std::deque<userrec*> chanuserlist;
75 // This #define allows us to call a method in all
76 // loaded modules in a readable simple way, e.g.:
77 // 'FOREACH_MOD OnConnect(user);'
79 #define FOREACH_MOD for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]->
81 // This define is similar to the one above but returns a result in MOD_RESULT.
82 // The first module to return a nonzero result is the value to be accepted,
83 // and any modules after are ignored.
85 // *********************************************************************************************
87 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
88 for (int _i = 0; _i <= MODCOUNT; _i++) { \
89 int res = modules[_i]->x ; \
97 // *********************************************************************************************
99 #define FD_MAGIC_NUMBER -42
101 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
102 extern void server_mode(char **parameters, int pcnt, userrec *user);
104 // class Version holds the version information of a Module, returned
105 // by Module::GetVersion (thanks RD)
107 /** Holds a module's Version information
108 * The four members (set by the constructor only) indicate details as to the version number
109 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
111 class Version : public classbase
114 const int Major, Minor, Revision, Build, Flags;
115 Version(int major, int minor, int revision, int build, int flags);
118 /** Holds /ADMIN data
119 * This class contains the admin details of the local server. It is constructed by class Server,
120 * and has three read-only values, Name, Email and Nick that contain the specified values for the
121 * server where the module is running.
123 class Admin : public classbase
126 const std::string Name, Email, Nick;
127 Admin(std::string name, std::string email, std::string nick);
131 // Forward-delacare module for ModuleMessage etc
134 // Thanks to Rob (from anope) for the idea of this message passing API
135 // (its been done before, but this seemed a very neat and tidy way...
137 /** The ModuleMessage class is the base class of Request and Event
138 * This class is used to represent a basic data structure which is passed
139 * between modules for safe inter-module communications.
141 class ModuleMessage : public classbase
144 /** This class is pure virtual and must be inherited.
146 virtual char* Send() = 0;
147 virtual ~ModuleMessage() {};
150 /** The Request class is a unicast message directed at a given module.
151 * When this class is properly instantiated it may be sent to a module
152 * using the Send() method, which will call the given module's OnRequest
153 * method with this class as its parameter.
155 class Request : public ModuleMessage
158 /** This member holds a pointer to arbitary data set by the emitter of the message
161 /** This is a pointer to the sender of the message, which can be used to
162 * directly trigger events, or to create a reply.
165 /** The single destination of the Request
169 /** Create a new Request
171 Request(char* anydata, Module* src, Module* dst);
172 /** Fetch the Request data
175 /** Fetch the request source
178 /** Fetch the request destination (should be 'this' in the receiving module)
181 /** Send the Request.
182 * Upon returning the result will be arbitary data returned by the module you
183 * sent the request to. It is up to your module to know what this data is and
184 * how to deal with it.
190 /** The Event class is a unicast message directed at all modules.
191 * When the class is properly instantiated it may be sent to all modules
192 * using the Send() method, which will trigger the OnEvent method in
193 * all modules passing the object as its parameter.
195 class Event : public ModuleMessage
198 /** This member holds a pointer to arbitary data set by the emitter of the message
201 /** This is a pointer to the sender of the message, which can be used to
202 * directly trigger events, or to create a reply.
205 /** The event identifier.
206 * This is arbitary text which should be used to distinguish
207 * one type of event from another.
211 /** Create a new Event
213 Event(char* anydata, Module* src, std::string eventid);
214 /** Get the Event data
217 /** Get the event Source
220 /** Get the event ID.
221 * Use this to determine the event type for safe casting of the data
223 std::string GetEventID();
225 * The return result of an Event::Send() will always be NULL as
226 * no replies are expected.
232 /** Base class for all InspIRCd modules
233 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
234 * its methods will be called when irc server events occur. class inherited from module must be
235 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
237 class Module : public classbase
241 /** Default constructor
242 * creates a module class
246 /** Default destructor
247 * destroys a module class
251 /** Returns the version number of a Module.
252 * The method should return a Version object with its version information assigned via
255 virtual Version GetVersion();
257 /** Called when a user connects.
258 * The details of the connecting user are available to you in the parameter userrec *user
260 virtual void OnUserConnect(userrec* user);
262 /** Called when a user quits.
263 * The details of the exiting user are available to you in the parameter userrec *user
264 * This event is only called when the user is fully registered when they quit. To catch
265 * raw disconnections, use the OnUserDisconnect method.
267 virtual void OnUserQuit(userrec* user);
269 /** Called whenever a user's socket is closed.
270 * The details of the exiting user are available to you in the parameter userrec *user
271 * This event is called for all users, registered or not, as a cleanup method for modules
272 * which might assign resources to user, such as dns lookups, objects and sockets.
274 virtual void OnUserDisconnect(userrec* user);
276 /** Called when a user joins a channel.
277 * The details of the joining user are available to you in the parameter userrec *user,
278 * and the details of the channel they have joined is available in the variable chanrec *channel
280 virtual void OnUserJoin(userrec* user, chanrec* channel);
282 /** Called when a user parts a channel.
283 * The details of the leaving user are available to you in the parameter userrec *user,
284 * and the details of the channel they have left is available in the variable chanrec *channel
286 virtual void OnUserPart(userrec* user, chanrec* channel);
288 /** Called before a packet is transmitted across the irc network between two irc servers.
289 * This allows you to easily represent it in the correct ways to implement encryption, compression,
290 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
291 * and will be called before ANY other operations within the ircd core program.
293 virtual void OnPacketTransmit(std::string &data, std::string serv);
295 /** Called after a packet is received from another irc server.
296 * This allows you to easily represent it in the correct ways to implement encryption, compression,
297 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
298 * and will be called immediately after the packet is received but before any other operations with the
301 virtual void OnPacketReceive(std::string &data, std::string serv);
303 /** Called on rehash.
304 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
305 * system. You should use it to reload any files so that your module keeps in step with the
306 * rest of the application.
308 virtual void OnRehash();
310 /** Called when a raw command is transmitted or received.
311 * This method is the lowest level of handler available to a module. It will be called with raw
312 * data which is passing through a connected socket. If you wish, you may munge this data by changing
313 * the string parameter "raw". If you do this, after your function exits it will immediately be
314 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
315 * inbound is set to true) the value of user will be the userrec of the connection sending the
316 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
318 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
320 /** Called whenever an extended mode is to be processed.
321 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
322 * changed. mode_on is set when the mode is being set, in which case params contains a list of
323 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
324 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
325 * was set up with Server::AddExtendedMode
326 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
327 * You must cast this value yourself to make use of it.
329 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
331 /** Called whenever a user is about to join a channel, before any processing is done.
332 * Returning a value of 1 from this function stops the process immediately, causing no
333 * output to be sent to the user by the core. If you do this you must produce your own numerics,
334 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
335 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
339 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
340 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
341 * processing on the actual channel record at this point, however the channel NAME will still be passed in
342 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
344 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
346 /** Called whenever a user is about to be kicked.
347 * Returning a value of 1 from this function stops the process immediately, causing no
348 * output to be sent to the user by the core. If you do this you must produce your own numerics,
351 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
353 /** Called whenever a user is kicked.
354 * If this method is called, the kick is already underway and cannot be prevented, so
355 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
357 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
359 /** Called whenever a user opers locally.
360 * The userrec will contain the oper mode 'o' as this function is called after any modifications
361 * are made to the user's structure by the core.
363 virtual void OnOper(userrec* user);
365 /** Called whenever a user types /INFO.
366 * The userrec will contain the information of the user who typed the command. Modules may use this
367 * method to output their own credits in /INFO (which is the ircd's version of an about box).
368 * It is purposefully not possible to modify any info that has already been output, or halt the list.
369 * You must write a 371 numeric to the user, containing your info in the following format:
371 * <nick> :information here
373 virtual void OnInfo(userrec* user);
375 /** Called whenever a /WHOIS is performed on a local user.
376 * The source parameter contains the details of the user who issued the WHOIS command, and
377 * the dest parameter contains the information of the user they are whoising.
379 virtual void OnWhois(userrec* source, userrec* dest);
381 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
382 * Returning 1 from this function stops the process immediately, causing no
383 * output to be sent to the user by the core. If you do this you must produce your own numerics,
384 * notices etc. This is useful for modules which may want to filter invites to channels.
386 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
388 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
389 * Returning any nonzero value from this function stops the process immediately, causing no
390 * output to be sent to the user by the core. If you do this you must produce your own numerics,
391 * notices etc. This is useful for modules which may want to filter or redirect messages.
392 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
393 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
394 * of where the message is destined to be sent.
396 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
398 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
399 * Returning any nonzero value from this function stops the process immediately, causing no
400 * output to be sent to the user by the core. If you do this you must produce your own numerics,
401 * notices etc. This is useful for modules which may want to filter or redirect messages.
402 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
403 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
404 * of where the message is destined to be sent.
405 * You may alter the message text as you wish before relinquishing control to the next module
406 * in the chain, and if no other modules block the text this altered form of the text will be sent out
407 * to the user and possibly to other servers.
409 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
411 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
412 * Please note that although you can see remote nickchanges through this function, you should
413 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
414 * check user->server before taking any action (including returning nonzero from the method).
415 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
416 * module to generate some meaninful output.
418 virtual int OnUserPreNick(userrec* user, std::string newnick);
420 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
421 * have been applied. Please note that although you can see remote nickchanges through this function, you should
422 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
423 * check user->server before taking any action (including returning nonzero from the method).
424 * Because this method is called after the nickchange is taken place, no return values are possible
425 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
427 virtual void OnUserPostNick(userrec* user, std::string oldnick);
429 /** Called before an action which requires a channel privilage check.
430 * This function is called before many functions which check a users status on a channel, for example
431 * before opping a user, deopping a user, kicking a user, etc.
432 * There are several values for access_type which indicate for what reason access is being checked.
434 * AC_KICK (0) - A user is being kicked<br>
435 * AC_DEOP (1) - a user is being deopped<br>
436 * AC_OP (2) - a user is being opped<br>
437 * AC_VOICE (3) - a user is being voiced<br>
438 * AC_DEVOICE (4) - a user is being devoiced<br>
439 * AC_HALFOP (5) - a user is being halfopped<br>
440 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
441 * AC_INVITE (7) - a user is being invited<br>
442 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
443 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
444 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
445 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
446 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
447 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
448 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
450 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
452 /** Called during a netburst to sync user data.
453 * This is called during the netburst on a per-user basis. You should use this call to up any special
454 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
455 * multiple commands in the string_list.
457 virtual string_list OnUserSync(userrec* user);
459 /** Called during a netburst to sync channel data.
460 * This is called during the netburst on a per-channel basis. You should use this call to up any special
461 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
462 * multiple commands in the string_list.
464 virtual string_list OnChannelSync(chanrec* chan);
466 /** Called when a 005 numeric is about to be output.
467 * The module should modify the 005 numeric if needed to indicate its features.
469 virtual void On005Numeric(std::string &output);
471 /** Called when a client is disconnected by KILL.
472 * If a client is killed by a server, e.g. a nickname collision or protocol error,
474 * Return 1 from this function to prevent the kill, and 0 from this function to allow
475 * it as normal. If you prevent the kill no output will be sent to the client, it is
476 * down to your module to generate this information.
477 * NOTE: It is NOT advisable to stop kills which originate from servers. If you do
478 * so youre risking race conditions, desyncs and worse!
480 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
482 /** Called whenever a module is loaded.
483 * mod will contain a pointer to the module, and string will contain its name,
484 * for example m_widgets.so. This function is primary for dependency checking,
485 * your module may decide to enable some extra features if it sees that you have
486 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
487 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
488 * but instead operate under reduced functionality, unless the dependency is
489 * absolutely neccessary (e.g. a module that extends the features of another
492 virtual void OnLoadModule(Module* mod,std::string name);
494 /** Called whenever a module is unloaded.
495 * mod will contain a pointer to the module, and string will contain its name,
496 * for example m_widgets.so. This function is primary for dependency checking,
497 * your module may decide to enable some extra features if it sees that you have
498 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
499 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
500 * but instead operate under reduced functionality, unless the dependency is
501 * absolutely neccessary (e.g. a module that extends the features of another
504 virtual void OnUnloadModule(Module* mod,std::string name);
506 /** Called once every five seconds for background processing.
507 * This timer can be used to control timed features. Its period is not accurate
508 * enough to be used as a clock, but it is gauranteed to be called at least once in
509 * any five second period, directly from the main loop of the server.
511 virtual void OnBackgroundTimer(time_t curtime);
513 /** Called whenever a list is needed for a listmode.
514 * For example, when a /MODE #channel +b (without any other parameters) is called,
515 * if a module was handling +b this function would be called. The function can then
516 * output any lists it wishes to. Please note that all modules will see all mode
517 * characters to provide the ability to extend each other, so please only output
518 * a list if the mode character given matches the one(s) you want to handle.
520 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
522 /** Called whenever any command is about to be executed.
523 * This event occurs for all registered commands, wether they are registered in the core,
524 * or another module, but it will not occur for invalid commands (e.g. ones which do not
525 * exist within the command table). By returning 1 from this method you may prevent the
526 * command being executed. If you do this, no output is created by the core, and it is
527 * down to your module to produce any output neccessary.
528 * Note that unless you return 1, you should not destroy any structures (e.g. by using
529 * Server::QuitUser) otherwise when the command's handler function executes after your
530 * method returns, it will be passed an invalid pointer to the user object and crash!)
532 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
534 /** Called to check if a user who is connecting can now be allowed to register
535 * If any modules return false for this function, the user is held in the waiting
536 * state until all modules return true. For example a module which implements ident
537 * lookups will continue to return false for a user until their ident lookup is completed.
538 * Note that the registration timeout for a user overrides these checks, if the registration
539 * timeout is reached, the user is disconnected even if modules report that the user is
540 * not ready to connect.
542 virtual bool OnCheckReady(userrec* user);
544 /** Called whenever a user is about to register their connection (e.g. before the user
545 * is sent the MOTD etc). Modules can use this method if they are performing a function
546 * which must be done before the actual connection is completed (e.g. ident lookups,
547 * dnsbl lookups, etc).
548 * Note that you should NOT delete the user record here by causing a disconnection!
549 * Use OnUserConnect for that instead.
551 virtual void OnUserRegister(userrec* user);
553 /** Called whenever a mode character is processed.
554 * Return 1 from this function to block the mode character from being processed entirely,
555 * so that you may perform your own code instead. Note that this method allows you to override
556 * modes defined by other modes, but this is NOT RECOMMENDED!
558 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
560 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
561 * This method will always be called for each join, wether or not the channel is actually +i, and
562 * determines the outcome of an if statement around the whole section of invite checking code.
563 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
565 virtual int OnCheckInvite(userrec* user, chanrec* chan);
567 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
568 * This method will always be called for each join, wether or not the channel is actually +k, and
569 * determines the outcome of an if statement around the whole section of key checking code.
570 * if the user specified no key, the keygiven string will be a valid but empty value.
571 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
573 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
575 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
576 * This method will always be called for each join, wether or not the channel is actually +l, and
577 * determines the outcome of an if statement around the whole section of channel limit checking code.
578 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
580 virtual int OnCheckLimit(userrec* user, chanrec* chan);
582 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
583 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
584 * determines the outcome of an if statement around the whole section of ban checking code.
585 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
587 virtual int OnCheckBan(userrec* user, chanrec* chan);
589 /** Called on all /STATS commands
590 * This method is triggered for all /STATS use, including stats symbols handled by the core.
592 virtual void OnStats(char symbol);
594 /** Called whenever a change of a local users displayed host is attempted.
595 * Return 1 to deny the host change, or 0 to allow it.
597 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
599 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
600 * return 1 to deny the name change, or 0 to allow it.
602 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
604 /** Called whenever a topic is changed by a local user.
605 * Return 1 to deny the topic change, or 0 to allow it.
607 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
609 /** Called whenever an unknown token is received in a server to server link.
610 * The token value is the unknown token -- please check that no other modules are using the token
611 * that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to
612 * all opers with +s. The params list is a list of parameters, and if any parameters start with a
613 * colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are
614 * handled. source is the sender of the message, and reply is what should be replied to for a unicast
615 * message. Note that there are not many messages in the mesh protocol which require unicast
616 * messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal
617 * notation and port is the port number it is using.
619 virtual int OnMeshToken(char token,string_list params,serverrec* source,serverrec* reply, std::string tcp_host,std::string ipaddr,int port);
621 /** Called whenever an Event class is sent to all module by another module.
622 * Please see the documentation of Event::Send() for further information. The Event sent can
623 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
624 * before doing anything to the event data, and you should *not* change the event data in any way!
626 virtual void OnEvent(Event* event);
628 /** Called whenever a Request class is sent to your module by another module.
629 * Please see the documentation of Request::Send() for further information. The Request sent
630 * can always be assumed to be non-NULL, you should not change the request object or its data.
631 * Your method may return arbitary data in the char* result which the requesting module
632 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
634 virtual char* OnRequest(Request* request);
636 /** Called whenever an oper password is to be compared to what a user has input.
637 * The password field (from the config file) is in 'password' and is to be compared against
638 * 'input'. This method allows for encryption of oper passwords and much more besides.
639 * You should return a nonzero value if you want to allow the comparison or zero if you wish
642 virtual int OnOperCompare(std::string password, std::string input);
644 /** Called whenever a user is given usermode +o, anywhere on the network.
645 * You cannot override this and prevent it from happening as it is already happened and
646 * such a task must be performed by another server. You can however bounce modes by sending
647 * servermodes out to reverse mode changes.
649 virtual void OnGlobalOper(userrec* user);
651 /** Called whenever a user connects, anywhere on the network.
652 * This event is informational only. You should not change any user information in this
653 * event. To do so, use the OnUserConnect method to change the state of local users.
655 virtual void OnGlobalConnect(userrec* user);
657 /** Called whenever a ban is added to a channel's list.
658 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
660 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
662 /** Called whenever a ban is removed from a channel's list.
663 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
665 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
667 /** Called immediately after any connection is accepted. This is intended for raw socket
668 * processing (e.g. modules which wrap the tcp connection within another library) and provides
669 * no information relating to a user record as the connection has not been assigned yet.
670 * There are no return values from this call as all modules get an opportunity if required to
671 * process the connection.
673 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
675 /** Called immediately before any write() operation on a user's socket in the core. Because
676 * this event is a low level event no user information is associated with it. It is intended
677 * for use by modules which may wrap connections within another API such as SSL for example.
678 * return a non-zero result if you have handled the write operation, in which case the core
679 * will not call write().
681 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
683 /** Called immediately before any socket is closed. When this event is called, shutdown()
684 * has not yet been called on the socket.
686 virtual void OnRawSocketClose(int fd);
688 /** Called immediately before any read() operation on a client socket in the core.
689 * This occurs AFTER the select() or poll() so there is always data waiting to be read
690 * when this event occurs.
691 * Your event should return 1 if it has handled the reading itself, which prevents the core
692 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
693 * the value of count. The value of readresult must be identical to an actual result that might
694 * be returned from the read() system call, for example, number of bytes read upon success,
695 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
696 * you MUST set readresult.
698 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
702 /** Allows server output and query functions
703 * This class contains methods which allow a module to query the state of the irc server, and produce
704 * output to users and other servers. All modules should instantiate at least one copy of this class,
705 * and use its member functions to perform their tasks.
707 class Server : public classbase
710 /** Default constructor.
711 * Creates a Server object.
714 /** Default destructor.
715 * Destroys a Server object.
719 /** Sends text to all opers.
720 * This method sends a server notice to all opers with the usermode +s.
722 virtual void SendOpers(std::string s);
723 /** Writes a log string.
724 * This method writes a line of text to the log. If the level given is lower than the
725 * level given in the configuration, this command has no effect.
727 virtual void Log(int level, std::string s);
728 /** Sends a line of text down a TCP/IP socket.
729 * This method writes a line of text to an established socket, cutting it to 510 characters
730 * plus a carriage return and linefeed if required.
732 virtual void Send(int Socket, std::string s);
733 /** Sends text from the server to a socket.
734 * This method writes a line of text to an established socket, with the servername prepended
735 * as used by numerics (see RFC 1459)
737 virtual void SendServ(int Socket, std::string s);
738 /** Writes text to a channel, but from a server, including all.
739 * This can be used to send server notices to a group of users.
741 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
742 /** Sends text from a user to a socket.
743 * This method writes a line of text to an established socket, with the given user's nick/ident
744 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
746 virtual void SendFrom(int Socket, userrec* User, std::string s);
747 /** Sends text from a user to another user.
748 * This method writes a line of text to a user, with a user's nick/ident
749 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
750 * If you specify NULL as the source, then the data will originate from the
751 * local server, e.g. instead of:
753 * :user!ident@host TEXT
755 * The format will become:
759 * Which is useful for numerics and server notices to single users, etc.
761 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
762 /** Sends text from a user to a channel (mulicast).
763 * This method writes a line of text to a channel, with the given user's nick/ident
764 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
765 * IncludeSender flag is set, then the text is also sent back to the user from which
766 * it originated, as seen in MODE (see RFC 1459).
768 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
769 /** Returns true if two users share a common channel.
770 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
773 virtual bool CommonChannels(userrec* u1, userrec* u2);
774 /** Sends text from a user to one or more channels (mulicast).
775 * This method writes a line of text to all users which share a common channel with a given
776 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
777 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
778 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
779 * is only sent to the other recipients, as seen in QUIT.
781 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
782 /** Sends a WALLOPS message.
783 * This method writes a WALLOPS message to all users with the +w flag, originating from the
786 virtual void SendWallops(userrec* User, std::string text);
788 /** Returns true if a nick is valid.
789 * Nicks for unregistered connections will return false.
791 virtual bool IsNick(std::string nick);
792 /** Returns a count of the number of users on a channel.
793 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
795 virtual int CountUsers(chanrec* c);
796 /** Attempts to look up a nick and return a pointer to it.
797 * This function will return NULL if the nick does not exist.
799 virtual userrec* FindNick(std::string nick);
800 /** Attempts to look up a nick using the file descriptor associated with that nick.
801 * This function will return NULL if the file descriptor is not associated with a valid user.
803 virtual userrec* FindDescriptor(int socket);
804 /** Attempts to look up a channel and return a pointer to it.
805 * This function will return NULL if the channel does not exist.
807 virtual chanrec* FindChannel(std::string channel);
808 /** Attempts to look up a user's privilages on a channel.
809 * This function will return a string containing either @, %, +, or an empty string,
810 * representing the user's privilages upon the channel you specify.
812 virtual std::string ChanMode(userrec* User, chanrec* Chan);
813 /** Checks if a user is on a channel.
814 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
816 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
817 /** Returns the server name of the server where the module is loaded.
819 virtual std::string GetServerName();
820 /** Returns the network name, global to all linked servers.
822 virtual std::string GetNetworkName();
823 /** Returns the server description string of the local server
825 virtual std::string GetServerDescription();
826 /** Returns the information of the server as returned by the /ADMIN command.
827 * See the Admin class for further information of the return value. The members
828 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
829 * server where the module is loaded.
831 virtual Admin GetAdmin();
832 /** Adds an extended mode letter which is parsed by a module.
833 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
834 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
835 * indicate wether the mode is a channel mode, a client mode, or a server mode.
836 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
837 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
838 * params_when_on is the number of modes to expect when the mode is turned on
839 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
840 * the params_when_off value has a similar value to params_when_on, except it indicates
841 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
842 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
843 * use this parameter. The function returns false if the mode is unavailable, and will not
844 * attempt to allocate another character, as this will confuse users. This also means that
845 * as only one module can claim a specific mode character, the core does not need to keep track
846 * of which modules own which modes, which speeds up operation of the server. In this version,
847 * a mode can have at most one parameter, attempting to use more parameters will have undefined
850 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
852 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
853 * This call is used to implement modes like +q and +a. The characteristics of these modes are
856 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
858 * (2) They always take exactly one parameter when being added or removed
860 * (3) They can be set multiple times, usually on users in channels
862 * (4) The mode and its parameter are NOT stored in the channels modes structure
864 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
865 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
866 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
867 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
868 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
869 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
870 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
871 * so the above example would become '+aa one three' after processing.
873 virtual bool AddExtendedListMode(char modechar);
875 /** Adds a command to the command table.
876 * This allows modules to add extra commands into the command table. You must place a function within your
877 * module which is is of type handlerfunc:
879 * typedef void (handlerfunc) (char**, int, userrec*);
881 * void handle_kill(char **parameters, int pcnt, userrec *user)
883 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
884 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
885 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
886 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
887 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
888 * The source parameter is used for resource tracking, and should contain the name of your module (with file
889 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
892 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
894 /** Sends a servermode.
895 * you must format the parameters array with the target, modes and parameters for those modes.
901 * modes[0] = ChannelName;
905 * modes[2] = user->nick;
907 * Srv->SendMode(modes,3,user);
909 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
910 * will be sent to the user you provide as the third parameter.
911 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
912 * your server in an unstable state!
915 virtual void SendMode(char **parameters, int pcnt, userrec *user);
917 /** Sends to all users matching a mode mask
918 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
919 * or module provided modes, including ones provided by your own module.
920 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
921 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
922 * for example, if you were to use:
924 * Serv->SendToModeMask("xi", WM_OR, "m00");
926 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
927 * user must have both modes set to receive the message.
929 virtual void SendToModeMask(std::string modes, int flags, std::string text);
931 /** Forces a user to join a channel.
932 * This is similar to svsjoin and can be used to implement redirection, etc.
933 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
934 * On failure, the result is NULL.
936 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
938 /** Forces a user to part a channel.
939 * This is similar to svspart and can be used to implement redirection, etc.
940 * Although the return value of this function is a pointer to a channel record, the returned data is
941 * undefined and should not be read or written to. This behaviour may be changed in a future version.
943 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
945 /** Forces a user nickchange.
946 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
947 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
948 * the error numeric for it.
950 virtual void ChangeUserNick(userrec* user, std::string nickname);
952 /** Forces a user to quit with the specified reason.
953 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
954 * may bypass the quit prefix specified in the config file.
958 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
959 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
960 * action after calling this method is to immediately bail from your handler.
962 virtual void QuitUser(userrec* user, std::string reason);
964 /** Matches text against a glob pattern.
965 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
966 * Returns true if the literal successfully matches the pattern, false if otherwise.
968 virtual bool MatchText(std::string sliteral, std::string spattern);
970 /** Calls the handler for a command, either implemented by the core or by another module.
971 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
972 * KICK etc, or even as a method of callback. By defining command names that are untypeable
973 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
974 * The first parameter to this method is the name of the command handler you wish to call, e.g.
975 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
976 * The second parameter is an array of parameters, and the third parameter is a count of parameters
977 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
978 * functiom will silently ignore it. The final parameter is the user executing the command handler,
979 * used for privilage checks, etc.
981 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
983 /** Change displayed hostname of a user.
984 * You should always call this method to change a user's host rather than writing directly to the
985 * dhost member of userrec, as any change applied via this method will be propogated to any
988 virtual void ChangeHost(userrec* user, std::string host);
990 /** Change GECOS (fullname) of a user.
991 * You should always call this method to change a user's GECOS rather than writing directly to the
992 * fullname member of userrec, as any change applied via this method will be propogated to any
995 virtual void ChangeGECOS(userrec* user, std::string gecos);
997 /** Returns true if the servername you give is ulined.
998 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
999 * change modes of clients which are on remote servers and set modes of channels where there are
1000 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
1001 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
1002 * case of normal servers, as many ulined server types (such as services) do not support meshed
1003 * links and must operate in this manner.
1005 virtual bool IsUlined(std::string server);
1007 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1008 * chanrec due to include constraints.
1010 virtual chanuserlist GetUsers(chanrec* chan);
1012 /** Remove a user's connection to the irc server, but leave their client in existence in the
1013 * user hash. When you call this function, the user's file descriptor will be replaced with the
1014 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1015 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1016 * After this call, the pointer to user will be invalid.
1018 virtual bool UserToPseudo(userrec* user,std::string message);
1020 /** This user takes one user, and switches their file descriptor with another user, so that one user
1021 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1022 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1023 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1024 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1026 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1029 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1030 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1031 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1032 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1035 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1038 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1039 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1040 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1041 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1044 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1047 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1048 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1049 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1050 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1053 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1056 * The K-line is enforced as soon as it is added.
1057 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1058 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1059 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1062 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1065 * The E-line is enforced as soon as it is added.
1066 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1067 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1068 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1071 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1073 /** Deletes a G-Line from all servers on the mesh
1075 virtual bool DelGLine(std::string hostmask);
1077 /** Deletes a Q-Line from all servers on the mesh
1079 virtual bool DelQLine(std::string nickname);
1081 /** Deletes a Z-Line from all servers on the mesh
1083 virtual bool DelZLine(std::string ipaddr);
1085 /** Deletes a local K-Line
1087 virtual bool DelKLine(std::string hostmask);
1089 /** Deletes a local E-Line
1091 virtual bool DelELine(std::string hostmask);
1093 /** Calculates a duration
1094 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1095 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1098 virtual long CalcDuration(std::string duration);
1100 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1102 virtual bool IsValidMask(std::string mask);
1104 /** Sends a line of text to all connected servers.
1105 * If a server is not directly reachable, the core deals with routing the message, and will also
1106 * deal with failures transparently.
1108 virtual void MeshSendAll(std::string text);
1110 /** This method sends a line of text to all servers who have users which share common channels with the user you provide.
1111 * For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on
1112 * channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be
1113 * sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about
1114 * this routing, it is done transparently, but its good to know how things work!)
1116 virtual void MeshSendCommon(userrec* user, std::string text);
1118 /** This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable.
1120 virtual void MeshSendAllAlive(std::string text);
1122 /** This function sends a line of text directly to a server.
1123 * If the server is not directly routable at this time, the server attempts to route text through the mesh.
1125 virtual void MeshSendUnicast(std::string destination, std::string text);
1127 /** This function sends to all servers EXCEPT the one you specify.
1128 * You should usually use this function to send messages, specifying the SENDER of your message as 'target'.
1129 * This will prevent message loops.
1131 virtual void MeshSendAllExcept(std::string target, std::string text);
1133 /** This function is used to check if any users on channel c are on server servername.
1134 * This is used internally by PRIVMSG etc. You should not need to use it.
1136 virtual bool MeshCheckChan(chanrec *c,std::string servername);
1138 /** This function is used to check if user u has any channels in common with users on servername.
1139 * This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
1141 virtual bool MeshCheckCommon(userrec* u,std::string servername);
1143 /** This function finds a module by name.
1144 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1145 * the function will return NULL.
1147 virtual Module* FindModule(std::string name);
1151 #define CONF_NOT_A_NUMBER 0x000010
1152 #define CONF_NOT_UNSIGNED 0x000080
1153 #define CONF_VALUE_NOT_FOUND 0x000100
1154 #define CONF_FILE_NOT_FOUND 0x000200
1157 /** Allows reading of values from configuration files
1158 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1159 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1160 * Constructing the class using one parameter allows you to specify a path to your own configuration
1161 * file, otherwise, inspircd.conf is read.
1163 class ConfigReader : public classbase
1166 /** The contents of the configuration file
1167 * This protected member should never be accessed by a module (and cannot be accessed unless the
1168 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1169 * (such as comments) stripped from it.
1171 std::stringstream *cache;
1172 std::stringstream *errorlog;
1173 /** Used to store errors
1179 /** Default constructor.
1180 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1181 * as specified when running ./configure.
1183 ConfigReader(); // default constructor reads ircd.conf
1184 /** Overloaded constructor.
1185 * This constructor initialises the ConfigReader class to read a user-specified config file
1187 ConfigReader(std::string filename); // read a module-specific config
1188 /** Default destructor.
1189 * This method destroys the ConfigReader class.
1192 /** Retrieves a value from the config file.
1193 * This method retrieves a value from the config file. Where multiple copies of the tag
1194 * exist in the config file, index indicates which of the values to retrieve.
1196 std::string ReadValue(std::string tag, std::string name, int index);
1197 /** Retrieves a boolean value from the config file.
1198 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1199 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1200 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1202 bool ReadFlag(std::string tag, std::string name, int index);
1203 /** Retrieves an integer value from the config file.
1204 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1205 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1206 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1207 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1208 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1209 * will return CONF_NOT_UNSIGNED
1211 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1212 /** Returns the last error to occur.
1213 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1214 * A call to GetError() resets the error flag back to 0.
1217 /** Counts the number of times a given tag appears in the config file.
1218 * This method counts the number of times a tag appears in a config file, for use where
1219 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1220 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1221 * multiple instance tag.
1223 int Enumerate(std::string tag);
1224 /** Returns true if a config file is valid.
1225 * This method is partially implemented and will only return false if the config
1226 * file does not exist or could not be opened.
1229 /** Dumps the list of errors in a config file to an output location. If bail is true,
1230 * then the program will abort. If bail is false and user points to a valid user
1231 * record, the error report will be spooled to the given user by means of NOTICE.
1232 * if bool is false AND user is false, the error report will be spooled to all opers
1233 * by means of a NOTICE to all opers.
1235 void DumpErrors(bool bail,userrec* user);
1237 /** Returns the number of items within a tag.
1238 * For example if the tag was <test tag="blah" data="foo"> then this
1239 * function would return 2. Spaces and newlines both qualify as valid seperators
1242 int EnumerateValues(std::string tag, int index);
1247 /** Caches a text file into memory and can be used to retrieve lines from it.
1248 * This class contains methods for read-only manipulation of a text file in memory.
1249 * Either use the constructor type with one parameter to load a file into memory
1250 * at construction, or use the LoadFile method to load a file.
1252 class FileReader : public classbase
1256 /** Default constructor.
1257 * This method does not load any file into memory, you must use the LoadFile method
1258 * after constructing the class this way.
1262 /** Secondary constructor.
1263 * This method initialises the class with a file loaded into it ready for GetLine and
1264 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1267 FileReader(std::string filename);
1269 /** Default destructor.
1270 * This deletes the memory allocated to the file.
1274 /** Used to load a file.
1275 * This method loads a file into the class ready for GetLine and
1276 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1279 void LoadFile(std::string filename);
1281 /** Returns true if the file exists
1282 * This function will return false if the file could not be opened.
1286 /** Retrieve one line from the file.
1287 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1288 * the index was out of bounds, or the line had no data on it.
1290 std::string GetLine(int x);
1292 /** Returns the size of the file in lines.
1293 * This method returns the number of lines in the read file. If it is 0, no lines have been
1294 * read into memory, either because the file is empty or it does not exist, or cannot be
1295 * opened due to permission problems.
1301 /** Instantiates classes inherited from Module
1302 * This class creates a class inherited from type Module, using new. This is to allow for modules
1303 * to create many different variants of Module, dependent on architecture, configuration, etc.
1304 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1307 class ModuleFactory : public classbase
1311 virtual ~ModuleFactory() { }
1312 /** Creates a new module.
1313 * Your inherited class of ModuleFactory must return a pointer to your Module class
1314 * using this method.
1316 virtual Module * CreateModule() = 0;
1320 typedef DLLFactory<ModuleFactory> ircd_module;