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;
149 /** The Request class is a unicast message directed at a given module.
150 * When this class is properly instantiated it may be sent to a module
151 * using the Send() method, which will call the given module's OnRequest
152 * method with this class as its parameter.
154 class Request : public ModuleMessage
157 /** This member holds a pointer to arbitary data set by the emitter of the message
160 /** This is a pointer to the sender of the message, which can be used to
161 * directly trigger events, or to create a reply.
164 /** The single destination of the Request
168 /** Create a new Request
170 Request(char* anydata, Module* src, Module* dst);
171 /** Fetch the Request data
174 /** Fetch the request source
177 /** Fetch the request destination (should be 'this' in the receiving module)
180 /** Send the Request.
181 * Upon returning the result will be arbitary data returned by the module you
182 * sent the request to. It is up to your module to know what this data is and
183 * how to deal with it.
189 /** The Event class is a unicast message directed at all modules.
190 * When the class is properly instantiated it may be sent to all modules
191 * using the Send() method, which will trigger the OnEvent method in
192 * all modules passing the object as its parameter.
194 class Event : public ModuleMessage
197 /** This member holds a pointer to arbitary data set by the emitter of the message
200 /** This is a pointer to the sender of the message, which can be used to
201 * directly trigger events, or to create a reply.
204 /** The event identifier.
205 * This is arbitary text which should be used to distinguish
206 * one type of event from another.
210 /** Create a new Event
212 Event(char* anydata, Module* src, std::string eventid);
213 /** Get the Event data
216 /** Get the event Source
219 /** Get the event ID.
220 * Use this to determine the event type for safe casting of the data
222 std::string GetEventID();
224 * The return result of an Event::Send() will always be NULL as
225 * no replies are expected.
231 /** Base class for all InspIRCd modules
232 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
233 * its methods will be called when irc server events occur. class inherited from module must be
234 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
236 class Module : public classbase
240 /** Default constructor
241 * creates a module class
245 /** Default destructor
246 * destroys a module class
250 /** Returns the version number of a Module.
251 * The method should return a Version object with its version information assigned via
254 virtual Version GetVersion();
256 /** Called when a user connects.
257 * The details of the connecting user are available to you in the parameter userrec *user
259 virtual void OnUserConnect(userrec* user);
261 /** Called when a user quits.
262 * The details of the exiting user are available to you in the parameter userrec *user
263 * This event is only called when the user is fully registered when they quit. To catch
264 * raw disconnections, use the OnUserDisconnect method.
266 virtual void OnUserQuit(userrec* user);
268 /** Called whenever a user's socket is closed.
269 * The details of the exiting user are available to you in the parameter userrec *user
270 * This event is called for all users, registered or not, as a cleanup method for modules
271 * which might assign resources to user, such as dns lookups, objects and sockets.
273 virtual void OnUserDisconnect(userrec* user);
275 /** Called when a user joins a channel.
276 * The details of the joining user are available to you in the parameter userrec *user,
277 * and the details of the channel they have joined is available in the variable chanrec *channel
279 virtual void OnUserJoin(userrec* user, chanrec* channel);
281 /** Called when a user parts a channel.
282 * The details of the leaving user are available to you in the parameter userrec *user,
283 * and the details of the channel they have left is available in the variable chanrec *channel
285 virtual void OnUserPart(userrec* user, chanrec* channel);
287 /** Called before a packet is transmitted across the irc network between two irc servers.
288 * This allows you to easily represent it in the correct ways to implement encryption, compression,
289 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
290 * and will be called before ANY other operations within the ircd core program.
292 virtual void OnPacketTransmit(std::string &data, std::string serv);
294 /** Called after a packet is received from another irc server.
295 * This allows you to easily represent it in the correct ways to implement encryption, compression,
296 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
297 * and will be called immediately after the packet is received but before any other operations with the
300 virtual void OnPacketReceive(std::string &data, std::string serv);
302 /** Called on rehash.
303 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
304 * system. You should use it to reload any files so that your module keeps in step with the
305 * rest of the application.
307 virtual void OnRehash();
309 /** Called when a raw command is transmitted or received.
310 * This method is the lowest level of handler available to a module. It will be called with raw
311 * data which is passing through a connected socket. If you wish, you may munge this data by changing
312 * the string parameter "raw". If you do this, after your function exits it will immediately be
313 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
314 * inbound is set to true) the value of user will be the userrec of the connection sending the
315 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
317 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
319 /** Called whenever an extended mode is to be processed.
320 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
321 * changed. mode_on is set when the mode is being set, in which case params contains a list of
322 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
323 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
324 * was set up with Server::AddExtendedMode
325 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
326 * You must cast this value yourself to make use of it.
328 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
330 /** Called whenever a user is about to join a channel, before any processing is done.
331 * Returning a value of 1 from this function stops the process immediately, causing no
332 * output to be sent to the user by the core. If you do this you must produce your own numerics,
333 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
334 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
338 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
339 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
340 * processing on the actual channel record at this point, however the channel NAME will still be passed in
341 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
343 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
345 /** Called whenever a user is about to be kicked.
346 * Returning a value of 1 from this function stops the process immediately, causing no
347 * output to be sent to the user by the core. If you do this you must produce your own numerics,
350 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
352 /** Called whenever a user is kicked.
353 * If this method is called, the kick is already underway and cannot be prevented, so
354 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
356 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
358 /** Called whenever a user opers locally.
359 * The userrec will contain the oper mode 'o' as this function is called after any modifications
360 * are made to the user's structure by the core.
362 virtual void OnOper(userrec* user);
364 /** Called whenever a user types /INFO.
365 * The userrec will contain the information of the user who typed the command. Modules may use this
366 * method to output their own credits in /INFO (which is the ircd's version of an about box).
367 * It is purposefully not possible to modify any info that has already been output, or halt the list.
368 * You must write a 371 numeric to the user, containing your info in the following format:
370 * <nick> :information here
372 virtual void OnInfo(userrec* user);
374 /** Called whenever a /WHOIS is performed on a local user.
375 * The source parameter contains the details of the user who issued the WHOIS command, and
376 * the dest parameter contains the information of the user they are whoising.
378 virtual void OnWhois(userrec* source, userrec* dest);
380 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
381 * Returning 1 from this function stops the process immediately, causing no
382 * output to be sent to the user by the core. If you do this you must produce your own numerics,
383 * notices etc. This is useful for modules which may want to filter invites to channels.
385 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
387 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
388 * Returning any nonzero value from this function stops the process immediately, causing no
389 * output to be sent to the user by the core. If you do this you must produce your own numerics,
390 * notices etc. This is useful for modules which may want to filter or redirect messages.
391 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
392 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
393 * of where the message is destined to be sent.
395 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
397 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
398 * Returning any nonzero value from this function stops the process immediately, causing no
399 * output to be sent to the user by the core. If you do this you must produce your own numerics,
400 * notices etc. This is useful for modules which may want to filter or redirect messages.
401 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
402 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
403 * of where the message is destined to be sent.
404 * You may alter the message text as you wish before relinquishing control to the next module
405 * in the chain, and if no other modules block the text this altered form of the text will be sent out
406 * to the user and possibly to other servers.
408 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
410 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
411 * Please note that although you can see remote nickchanges through this function, you should
412 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
413 * check user->server before taking any action (including returning nonzero from the method).
414 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
415 * module to generate some meaninful output.
417 virtual int OnUserPreNick(userrec* user, std::string newnick);
419 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
420 * have been applied. Please note that although you can see remote nickchanges through this function, you should
421 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
422 * check user->server before taking any action (including returning nonzero from the method).
423 * Because this method is called after the nickchange is taken place, no return values are possible
424 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
426 virtual void OnUserPostNick(userrec* user, std::string oldnick);
428 /** Called before an action which requires a channel privilage check.
429 * This function is called before many functions which check a users status on a channel, for example
430 * before opping a user, deopping a user, kicking a user, etc.
431 * There are several values for access_type which indicate for what reason access is being checked.
433 * AC_KICK (0) - A user is being kicked<br>
434 * AC_DEOP (1) - a user is being deopped<br>
435 * AC_OP (2) - a user is being opped<br>
436 * AC_VOICE (3) - a user is being voiced<br>
437 * AC_DEVOICE (4) - a user is being devoiced<br>
438 * AC_HALFOP (5) - a user is being halfopped<br>
439 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
440 * AC_INVITE (7) - a user is being invited<br>
441 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
442 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
443 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
444 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
445 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
446 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
447 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
449 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
451 /** Called during a netburst to sync user data.
452 * This is called during the netburst on a per-user basis. You should use this call to up any special
453 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
454 * multiple commands in the string_list.
456 virtual string_list OnUserSync(userrec* user);
458 /** Called during a netburst to sync channel data.
459 * This is called during the netburst on a per-channel basis. You should use this call to up any special
460 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
461 * multiple commands in the string_list.
463 virtual string_list OnChannelSync(chanrec* chan);
465 /** Called when a 005 numeric is about to be output.
466 * The module should modify the 005 numeric if needed to indicate its features.
468 virtual void On005Numeric(std::string &output);
470 /** Called when a client is disconnected by KILL.
471 * If a client is killed by a server, e.g. a nickname collision or protocol error,
473 * Return 1 from this function to prevent the kill, and 0 from this function to allow
474 * it as normal. If you prevent the kill no output will be sent to the client, it is
475 * down to your module to generate this information.
476 * NOTE: It is NOT advisable to stop kills which originate from servers. If you do
477 * so youre risking race conditions, desyncs and worse!
479 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
481 /** Called whenever a module is loaded.
482 * mod will contain a pointer to the module, and string will contain its name,
483 * for example m_widgets.so. This function is primary for dependency checking,
484 * your module may decide to enable some extra features if it sees that you have
485 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
486 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
487 * but instead operate under reduced functionality, unless the dependency is
488 * absolutely neccessary (e.g. a module that extends the features of another
491 virtual void OnLoadModule(Module* mod,std::string name);
493 /** Called once every five seconds for background processing.
494 * This timer can be used to control timed features. Its period is not accurate
495 * enough to be used as a clock, but it is gauranteed to be called at least once in
496 * any five second period, directly from the main loop of the server.
498 virtual void OnBackgroundTimer(time_t curtime);
500 /** Called whenever a list is needed for a listmode.
501 * For example, when a /MODE #channel +b (without any other parameters) is called,
502 * if a module was handling +b this function would be called. The function can then
503 * output any lists it wishes to. Please note that all modules will see all mode
504 * characters to provide the ability to extend each other, so please only output
505 * a list if the mode character given matches the one(s) you want to handle.
507 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
509 /** Called whenever any command is about to be executed.
510 * This event occurs for all registered commands, wether they are registered in the core,
511 * or another module, but it will not occur for invalid commands (e.g. ones which do not
512 * exist within the command table). By returning 1 from this method you may prevent the
513 * command being executed. If you do this, no output is created by the core, and it is
514 * down to your module to produce any output neccessary.
515 * Note that unless you return 1, you should not destroy any structures (e.g. by using
516 * Server::QuitUser) otherwise when the command's handler function executes after your
517 * method returns, it will be passed an invalid pointer to the user object and crash!)
519 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
521 /** Called to check if a user who is connecting can now be allowed to register
522 * If any modules return false for this function, the user is held in the waiting
523 * state until all modules return true. For example a module which implements ident
524 * lookups will continue to return false for a user until their ident lookup is completed.
525 * Note that the registration timeout for a user overrides these checks, if the registration
526 * timeout is reached, the user is disconnected even if modules report that the user is
527 * not ready to connect.
529 virtual bool OnCheckReady(userrec* user);
531 /** Called whenever a user is about to register their connection (e.g. before the user
532 * is sent the MOTD etc). Modules can use this method if they are performing a function
533 * which must be done before the actual connection is completed (e.g. ident lookups,
534 * dnsbl lookups, etc).
535 * Note that you should NOT delete the user record here by causing a disconnection!
536 * Use OnUserConnect for that instead.
538 virtual void OnUserRegister(userrec* user);
540 /** Called whenever a mode character is processed.
541 * Return 1 from this function to block the mode character from being processed entirely,
542 * so that you may perform your own code instead. Note that this method allows you to override
543 * modes defined by other modes, but this is NOT RECOMMENDED!
545 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
547 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
548 * This method will always be called for each join, wether or not the channel is actually +i, and
549 * determines the outcome of an if statement around the whole section of invite checking code.
550 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
552 virtual int OnCheckInvite(userrec* user, chanrec* chan);
554 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
555 * This method will always be called for each join, wether or not the channel is actually +k, and
556 * determines the outcome of an if statement around the whole section of key checking code.
557 * if the user specified no key, the keygiven string will be a valid but empty value.
558 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
560 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
562 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
563 * This method will always be called for each join, wether or not the channel is actually +l, and
564 * determines the outcome of an if statement around the whole section of channel limit checking code.
565 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
567 virtual int OnCheckLimit(userrec* user, chanrec* chan);
569 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
570 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
571 * determines the outcome of an if statement around the whole section of ban checking code.
572 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
574 virtual int OnCheckBan(userrec* user, chanrec* chan);
576 /** Called on all /STATS commands
577 * This method is triggered for all /STATS use, including stats symbols handled by the core.
579 virtual void OnStats(char symbol);
581 /** Called whenever a change of a local users displayed host is attempted.
582 * Return 1 to deny the host change, or 0 to allow it.
584 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
586 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
587 * return 1 to deny the name change, or 0 to allow it.
589 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
591 /** Called whenever a topic is changed by a local user.
592 * Return 1 to deny the topic change, or 0 to allow it.
594 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
596 /** Called whenever an unknown token is received in a server to server link.
597 * The token value is the unknown token -- please check that no other modules are using the token
598 * that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to
599 * all opers with +s. The params list is a list of parameters, and if any parameters start with a
600 * colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are
601 * handled. source is the sender of the message, and reply is what should be replied to for a unicast
602 * message. Note that there are not many messages in the mesh protocol which require unicast
603 * messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal
604 * notation and port is the port number it is using.
606 virtual int OnMeshToken(char token,string_list params,serverrec* source,serverrec* reply, std::string tcp_host,std::string ipaddr,int port);
608 /** Called whenever an Event class is sent to all module by another module.
609 * Please see the documentation of Event::Send() for further information. The Event sent can
610 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
611 * before doing anything to the event data, and you should *not* change the event data in any way!
613 virtual void OnEvent(Event* event);
615 /** Called whenever a Request class is sent to your module by another module.
616 * Please see the documentation of Request::Send() for further information. The Request sent
617 * can always be assumed to be non-NULL, you should not change the request object or its data.
618 * Your method may return arbitary data in the char* result which the requesting module
619 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
621 virtual char* OnRequest(Request* request);
623 /** Called whenever an oper password is to be compared to what a user has input.
624 * The password field (from the config file) is in 'password' and is to be compared against
625 * 'input'. This method allows for encryption of oper passwords and much more besides.
626 * You should return a nonzero value if you want to allow the comparison or zero if you wish
629 virtual int OnOperCompare(std::string password, std::string input);
631 /** Called whenever a user is given usermode +o, anywhere on the network.
632 * You cannot override this and prevent it from happening as it is already happened and
633 * such a task must be performed by another server. You can however bounce modes by sending
634 * servermodes out to reverse mode changes.
636 virtual void OnGlobalOper(userrec* user);
638 /** Called whenever a user connects, anywhere on the network.
639 * This event is informational only. You should not change any user information in this
640 * event. To do so, use the OnUserConnect method to change the state of local users.
642 virtual void OnGlobalConnect(userrec* user);
644 /** Called whenever a ban is added to a channel's list.
645 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
647 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
649 /** Called whenever a ban is removed from a channel's list.
650 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
652 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
654 /** Called immediately after any connection is accepted. This is intended for raw socket
655 * processing (e.g. modules which wrap the tcp connection within another library) and provides
656 * no information relating to a user record as the connection has not been assigned yet.
657 * There are no return values from this call as all modules get an opportunity if required to
658 * process the connection.
660 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
662 /** Called immediately before any write() operation on a user's socket in the core. Because
663 * this event is a low level event no user information is associated with it. It is intended
664 * for use by modules which may wrap connections within another API such as SSL for example.
665 * return a non-zero result if you have handled the write operation, in which case the core
666 * will not call write().
668 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
670 /** Called immediately before any socket is closed. When this event is called, shutdown()
671 * has not yet been called on the socket.
673 virtual void OnRawSocketClose(int fd);
675 /** Called immediately before any read() operation on a client socket in the core.
676 * This occurs AFTER the select() or poll() so there is always data waiting to be read
677 * when this event occurs.
678 * Your event should return 1 if it has handled the reading itself, which prevents the core
679 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
680 * the value of count. The value of readresult must be identical to an actual result that might
681 * be returned from the read() system call, for example, number of bytes read upon success,
682 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
683 * you MUST set readresult.
685 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
689 /** Allows server output and query functions
690 * This class contains methods which allow a module to query the state of the irc server, and produce
691 * output to users and other servers. All modules should instantiate at least one copy of this class,
692 * and use its member functions to perform their tasks.
694 class Server : public classbase
697 /** Default constructor.
698 * Creates a Server object.
701 /** Default destructor.
702 * Destroys a Server object.
706 /** Sends text to all opers.
707 * This method sends a server notice to all opers with the usermode +s.
709 virtual void SendOpers(std::string s);
710 /** Writes a log string.
711 * This method writes a line of text to the log. If the level given is lower than the
712 * level given in the configuration, this command has no effect.
714 virtual void Log(int level, std::string s);
715 /** Sends a line of text down a TCP/IP socket.
716 * This method writes a line of text to an established socket, cutting it to 510 characters
717 * plus a carriage return and linefeed if required.
719 virtual void Send(int Socket, std::string s);
720 /** Sends text from the server to a socket.
721 * This method writes a line of text to an established socket, with the servername prepended
722 * as used by numerics (see RFC 1459)
724 virtual void SendServ(int Socket, std::string s);
725 /** Writes text to a channel, but from a server, including all.
726 * This can be used to send server notices to a group of users.
728 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
729 /** Sends text from a user to a socket.
730 * This method writes a line of text to an established socket, with the given user's nick/ident
731 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
733 virtual void SendFrom(int Socket, userrec* User, std::string s);
734 /** Sends text from a user to another user.
735 * This method writes a line of text to a user, with a user's nick/ident
736 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
737 * If you specify NULL as the source, then the data will originate from the
738 * local server, e.g. instead of:
740 * :user!ident@host TEXT
742 * The format will become:
746 * Which is useful for numerics and server notices to single users, etc.
748 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
749 /** Sends text from a user to a channel (mulicast).
750 * This method writes a line of text to a channel, with the given user's nick/ident
751 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
752 * IncludeSender flag is set, then the text is also sent back to the user from which
753 * it originated, as seen in MODE (see RFC 1459).
755 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
756 /** Returns true if two users share a common channel.
757 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
760 virtual bool CommonChannels(userrec* u1, userrec* u2);
761 /** Sends text from a user to one or more channels (mulicast).
762 * This method writes a line of text to all users which share a common channel with a given
763 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
764 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
765 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
766 * is only sent to the other recipients, as seen in QUIT.
768 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
769 /** Sends a WALLOPS message.
770 * This method writes a WALLOPS message to all users with the +w flag, originating from the
773 virtual void SendWallops(userrec* User, std::string text);
775 /** Returns true if a nick is valid.
776 * Nicks for unregistered connections will return false.
778 virtual bool IsNick(std::string nick);
779 /** Returns a count of the number of users on a channel.
780 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
782 virtual int CountUsers(chanrec* c);
783 /** Attempts to look up a nick and return a pointer to it.
784 * This function will return NULL if the nick does not exist.
786 virtual userrec* FindNick(std::string nick);
787 /** Attempts to look up a nick using the file descriptor associated with that nick.
788 * This function will return NULL if the file descriptor is not associated with a valid user.
790 virtual userrec* FindDescriptor(int socket);
791 /** Attempts to look up a channel and return a pointer to it.
792 * This function will return NULL if the channel does not exist.
794 virtual chanrec* FindChannel(std::string channel);
795 /** Attempts to look up a user's privilages on a channel.
796 * This function will return a string containing either @, %, +, or an empty string,
797 * representing the user's privilages upon the channel you specify.
799 virtual std::string ChanMode(userrec* User, chanrec* Chan);
800 /** Checks if a user is on a channel.
801 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
803 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
804 /** Returns the server name of the server where the module is loaded.
806 virtual std::string GetServerName();
807 /** Returns the network name, global to all linked servers.
809 virtual std::string GetNetworkName();
810 /** Returns the server description string of the local server
812 virtual std::string GetServerDescription();
813 /** Returns the information of the server as returned by the /ADMIN command.
814 * See the Admin class for further information of the return value. The members
815 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
816 * server where the module is loaded.
818 virtual Admin GetAdmin();
819 /** Adds an extended mode letter which is parsed by a module.
820 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
821 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
822 * indicate wether the mode is a channel mode, a client mode, or a server mode.
823 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
824 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
825 * params_when_on is the number of modes to expect when the mode is turned on
826 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
827 * the params_when_off value has a similar value to params_when_on, except it indicates
828 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
829 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
830 * use this parameter. The function returns false if the mode is unavailable, and will not
831 * attempt to allocate another character, as this will confuse users. This also means that
832 * as only one module can claim a specific mode character, the core does not need to keep track
833 * of which modules own which modes, which speeds up operation of the server. In this version,
834 * a mode can have at most one parameter, attempting to use more parameters will have undefined
837 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
839 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
840 * This call is used to implement modes like +q and +a. The characteristics of these modes are
843 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
845 * (2) They always take exactly one parameter when being added or removed
847 * (3) They can be set multiple times, usually on users in channels
849 * (4) The mode and its parameter are NOT stored in the channels modes structure
851 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
852 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
853 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
854 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
855 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
856 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
857 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
858 * so the above example would become '+aa one three' after processing.
860 virtual bool AddExtendedListMode(char modechar);
862 /** Adds a command to the command table.
863 * This allows modules to add extra commands into the command table. You must place a function within your
864 * module which is is of type handlerfunc:
866 * typedef void (handlerfunc) (char**, int, userrec*);
868 * void handle_kill(char **parameters, int pcnt, userrec *user)
870 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
871 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
872 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
873 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
874 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
875 * The source parameter is used for resource tracking, and should contain the name of your module (with file
876 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
879 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
881 /** Sends a servermode.
882 * you must format the parameters array with the target, modes and parameters for those modes.
888 * modes[0] = ChannelName;
892 * modes[2] = user->nick;
894 * Srv->SendMode(modes,3,user);
896 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
897 * will be sent to the user you provide as the third parameter.
898 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
899 * your server in an unstable state!
902 virtual void SendMode(char **parameters, int pcnt, userrec *user);
904 /** Sends to all users matching a mode mask
905 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
906 * or module provided modes, including ones provided by your own module.
907 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
908 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
909 * for example, if you were to use:
911 * Serv->SendToModeMask("xi", WM_OR, "m00");
913 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
914 * user must have both modes set to receive the message.
916 virtual void SendToModeMask(std::string modes, int flags, std::string text);
918 /** Forces a user to join a channel.
919 * This is similar to svsjoin and can be used to implement redirection, etc.
920 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
921 * On failure, the result is NULL.
923 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
925 /** Forces a user to part a channel.
926 * This is similar to svspart and can be used to implement redirection, etc.
927 * Although the return value of this function is a pointer to a channel record, the returned data is
928 * undefined and should not be read or written to. This behaviour may be changed in a future version.
930 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
932 /** Forces a user nickchange.
933 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
934 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
935 * the error numeric for it.
937 virtual void ChangeUserNick(userrec* user, std::string nickname);
939 /** Forces a user to quit with the specified reason.
940 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
941 * may bypass the quit prefix specified in the config file.
945 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
946 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
947 * action after calling this method is to immediately bail from your handler.
949 virtual void QuitUser(userrec* user, std::string reason);
951 /** Matches text against a glob pattern.
952 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
953 * Returns true if the literal successfully matches the pattern, false if otherwise.
955 virtual bool MatchText(std::string sliteral, std::string spattern);
957 /** Calls the handler for a command, either implemented by the core or by another module.
958 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
959 * KICK etc, or even as a method of callback. By defining command names that are untypeable
960 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
961 * The first parameter to this method is the name of the command handler you wish to call, e.g.
962 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
963 * The second parameter is an array of parameters, and the third parameter is a count of parameters
964 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
965 * functiom will silently ignore it. The final parameter is the user executing the command handler,
966 * used for privilage checks, etc.
968 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
970 /** Change displayed hostname of a user.
971 * You should always call this method to change a user's host rather than writing directly to the
972 * dhost member of userrec, as any change applied via this method will be propogated to any
975 virtual void ChangeHost(userrec* user, std::string host);
977 /** Change GECOS (fullname) of a user.
978 * You should always call this method to change a user's GECOS rather than writing directly to the
979 * fullname member of userrec, as any change applied via this method will be propogated to any
982 virtual void ChangeGECOS(userrec* user, std::string gecos);
984 /** Returns true if the servername you give is ulined.
985 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
986 * change modes of clients which are on remote servers and set modes of channels where there are
987 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
988 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
989 * case of normal servers, as many ulined server types (such as services) do not support meshed
990 * links and must operate in this manner.
992 virtual bool IsUlined(std::string server);
994 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
995 * chanrec due to include constraints.
997 virtual chanuserlist GetUsers(chanrec* chan);
999 /** Remove a user's connection to the irc server, but leave their client in existence in the
1000 * user hash. When you call this function, the user's file descriptor will be replaced with the
1001 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1002 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1003 * After this call, the pointer to user will be invalid.
1005 virtual bool UserToPseudo(userrec* user,std::string message);
1007 /** This user takes one user, and switches their file descriptor with another user, so that one user
1008 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1009 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1010 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1011 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1013 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1016 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1017 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1018 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1019 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1022 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1025 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1026 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1027 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1028 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1031 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1034 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1035 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1036 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1037 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1040 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1043 * The K-line is enforced as soon as it is added.
1044 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1045 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1046 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1049 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1052 * The E-line is enforced as soon as it is added.
1053 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1054 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1055 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1058 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1060 /** Deletes a G-Line from all servers on the mesh
1062 virtual bool DelGLine(std::string hostmask);
1064 /** Deletes a Q-Line from all servers on the mesh
1066 virtual bool DelQLine(std::string nickname);
1068 /** Deletes a Z-Line from all servers on the mesh
1070 virtual bool DelZLine(std::string ipaddr);
1072 /** Deletes a local K-Line
1074 virtual bool DelKLine(std::string hostmask);
1076 /** Deletes a local E-Line
1078 virtual bool DelELine(std::string hostmask);
1080 /** Calculates a duration
1081 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1082 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1085 virtual long CalcDuration(std::string duration);
1087 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1089 virtual bool IsValidMask(std::string mask);
1091 /** Sends a line of text to all connected servers.
1092 * If a server is not directly reachable, the core deals with routing the message, and will also
1093 * deal with failures transparently.
1095 virtual void MeshSendAll(std::string text);
1097 /** This method sends a line of text to all servers who have users which share common channels with the user you provide.
1098 * 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
1099 * channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be
1100 * 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
1101 * this routing, it is done transparently, but its good to know how things work!)
1103 virtual void MeshSendCommon(userrec* user, std::string text);
1105 /** This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable.
1107 virtual void MeshSendAllAlive(std::string text);
1109 /** This function sends a line of text directly to a server.
1110 * If the server is not directly routable at this time, the server attempts to route text through the mesh.
1112 virtual void MeshSendUnicast(std::string destination, std::string text);
1114 /** This function sends to all servers EXCEPT the one you specify.
1115 * You should usually use this function to send messages, specifying the SENDER of your message as 'target'.
1116 * This will prevent message loops.
1118 virtual void MeshSendAllExcept(std::string target, std::string text);
1120 /** This function is used to check if any users on channel c are on server servername.
1121 * This is used internally by PRIVMSG etc. You should not need to use it.
1123 virtual bool MeshCheckChan(chanrec *c,std::string servername);
1125 /** This function is used to check if user u has any channels in common with users on servername.
1126 * This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
1128 virtual bool MeshCheckCommon(userrec* u,std::string servername);
1130 /** This function finds a module by name.
1131 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1132 * the function will return NULL.
1134 virtual Module* FindModule(std::string name);
1138 #define CONF_NOT_A_NUMBER 0x000010
1139 #define CONF_NOT_UNSIGNED 0x000080
1140 #define CONF_VALUE_NOT_FOUND 0x000100
1141 #define CONF_FILE_NOT_FOUND 0x000200
1144 /** Allows reading of values from configuration files
1145 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1146 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1147 * Constructing the class using one parameter allows you to specify a path to your own configuration
1148 * file, otherwise, inspircd.conf is read.
1150 class ConfigReader : public classbase
1153 /** The contents of the configuration file
1154 * This protected member should never be accessed by a module (and cannot be accessed unless the
1155 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1156 * (such as comments) stripped from it.
1158 std::stringstream *cache;
1159 std::stringstream *errorlog;
1160 /** Used to store errors
1166 /** Default constructor.
1167 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1168 * as specified when running ./configure.
1170 ConfigReader(); // default constructor reads ircd.conf
1171 /** Overloaded constructor.
1172 * This constructor initialises the ConfigReader class to read a user-specified config file
1174 ConfigReader(std::string filename); // read a module-specific config
1175 /** Default destructor.
1176 * This method destroys the ConfigReader class.
1179 /** Retrieves a value from the config file.
1180 * This method retrieves a value from the config file. Where multiple copies of the tag
1181 * exist in the config file, index indicates which of the values to retrieve.
1183 std::string ReadValue(std::string tag, std::string name, int index);
1184 /** Retrieves a boolean value from the config file.
1185 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1186 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1187 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1189 bool ReadFlag(std::string tag, std::string name, int index);
1190 /** Retrieves an integer value from the config file.
1191 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1192 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1193 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1194 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1195 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1196 * will return CONF_NOT_UNSIGNED
1198 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1199 /** Returns the last error to occur.
1200 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1201 * A call to GetError() resets the error flag back to 0.
1204 /** Counts the number of times a given tag appears in the config file.
1205 * This method counts the number of times a tag appears in a config file, for use where
1206 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1207 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1208 * multiple instance tag.
1210 int Enumerate(std::string tag);
1211 /** Returns true if a config file is valid.
1212 * This method is partially implemented and will only return false if the config
1213 * file does not exist or could not be opened.
1216 /** Dumps the list of errors in a config file to an output location. If bail is true,
1217 * then the program will abort. If bail is false and user points to a valid user
1218 * record, the error report will be spooled to the given user by means of NOTICE.
1219 * if bool is false AND user is false, the error report will be spooled to all opers
1220 * by means of a NOTICE to all opers.
1222 void DumpErrors(bool bail,userrec* user);
1224 /** Returns the number of items within a tag.
1225 * For example if the tag was <test tag="blah" data="foo"> then this
1226 * function would return 2. Spaces and newlines both qualify as valid seperators
1229 int EnumerateValues(std::string tag, int index);
1234 /** Caches a text file into memory and can be used to retrieve lines from it.
1235 * This class contains methods for read-only manipulation of a text file in memory.
1236 * Either use the constructor type with one parameter to load a file into memory
1237 * at construction, or use the LoadFile method to load a file.
1239 class FileReader : public classbase
1243 /** Default constructor.
1244 * This method does not load any file into memory, you must use the LoadFile method
1245 * after constructing the class this way.
1249 /** Secondary constructor.
1250 * This method initialises the class with a file loaded into it ready for GetLine and
1251 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1254 FileReader(std::string filename);
1256 /** Default destructor.
1257 * This deletes the memory allocated to the file.
1261 /** Used to load a file.
1262 * This method loads a file into the class ready for GetLine and
1263 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1266 void LoadFile(std::string filename);
1268 /** Returns true if the file exists
1269 * This function will return false if the file could not be opened.
1273 /** Retrieve one line from the file.
1274 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1275 * the index was out of bounds, or the line had no data on it.
1277 std::string GetLine(int x);
1279 /** Returns the size of the file in lines.
1280 * This method returns the number of lines in the read file. If it is 0, no lines have been
1281 * read into memory, either because the file is empty or it does not exist, or cannot be
1282 * opened due to permission problems.
1288 /** Instantiates classes inherited from Module
1289 * This class creates a class inherited from type Module, using new. This is to allow for modules
1290 * to create many different variants of Module, dependent on architecture, configuration, etc.
1291 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1294 class ModuleFactory : public classbase
1298 virtual ~ModuleFactory() { }
1299 /** Creates a new module.
1300 * Your inherited class of ModuleFactory must return a pointer to your Module class
1301 * using this method.
1303 virtual Module * CreateModule() = 0;
1307 typedef DLLFactory<ModuleFactory> ircd_module;