1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 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 * ---------------------------------------------------
17 #ifndef __INSPIRCD_H__
18 #define __INSPIRCD_H__
23 #include "inspircd_config.h"
29 #include "socketengine.h"
30 #include "command_parse.h"
32 /** Returned by some functions to indicate failure,
33 * and the exit code of the program if it terminates.
39 #define ETIREDGERBILS EAGAIN
41 /** Debug levels for use with InspIRCd::Log()
53 * This define is used in place of strcmp when we
54 * want to check if a char* string contains only one
55 * letter. Pretty fast, its just two compares and an
58 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
60 /** Delete a pointer, and NULL its value
62 #define DELETE(x) {if (x) { delete x; x = NULL; }}
64 /** Template function to convert any input type to std::string
66 template<typename T> inline std::string ConvToStr(const T &in)
68 std::stringstream tmp;
69 if (!(tmp << in)) return std::string();
73 /** This class contains various STATS counters
74 * It is used by the InspIRCd class, which internally
75 * has an instance of it.
77 class serverstats : public classbase
80 /** Number of accepted connections
82 unsigned long statsAccept;
83 /** Number of failed accepts
85 unsigned long statsRefused;
86 /** Number of unknown commands seen
88 unsigned long statsUnknown;
89 /** Number of nickname collisions handled
91 unsigned long statsCollisions;
92 /** Number of DNS queries sent out
94 unsigned long statsDns;
95 /** Number of good DNS replies received
96 * NOTE: This may not tally to the number sent out,
97 * due to timeouts and other latency issues.
99 unsigned long statsDnsGood;
100 /** Number of bad (negative) DNS replies received
101 * NOTE: This may not tally to the number sent out,
102 * due to timeouts and other latency issues.
104 unsigned long statsDnsBad;
105 /** Number of inbound connections seen
107 unsigned long statsConnects;
108 /** Total bytes of data transmitted
111 /** Total bytes of data received
114 /** Number of bound listening ports
116 unsigned long BoundPortCount;
118 /** The constructor initializes all the counts to zero
121 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
122 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0),
130 /** The main singleton class of the irc server.
131 * This class contains instances of all the other classes
132 * in this software, with the exception of the base class,
133 * classbase. Amongst other things, it contains a ModeParser,
134 * a DNS object, a CommandParser object, and a list of active
135 * Module objects, and facilities for Module objects to
136 * interact with the core system it implements. You should
137 * NEVER attempt to instantiate a class of type InspIRCd
138 * yourself. If you do, this is equivalent to spawning a second
139 * IRC server, and could have catastrophic consequences for the
140 * program in terms of ram usage (basically, you could create
141 * an obese forkbomb built from recursively spawning irc servers!)
143 class InspIRCd : public classbase
146 /** Holds a string describing the last module error to occur
150 /** This is an internal flag used by the mainloop
154 /** List of server names we've seen.
156 servernamelist servernames;
158 /** Remove a ModuleFactory pointer
159 * @param j Index number of the ModuleFactory to remove
161 void EraseFactory(int j);
163 /** Remove a Module pointer
164 * @param j Index number of the Module to remove
166 void EraseModule(int j);
168 /** Build the ISUPPORT string by triggering all modules On005Numeric events
170 void BuildISupport();
172 /** Move a given module to a specific slot in the list
173 * @param modulename The module name to relocate
174 * @param slot The slot to move the module into
176 void MoveTo(std::string modulename,int slot);
178 /** Display the startup banner
182 /** Set up the signal handlers
183 * @param SEGVHandler create a handler for segfaults (deprecated)
185 void SetSignals(bool SEGVHandler);
187 /** Daemonize the ircd and close standard input/output streams
188 * @return True if the program daemonized succesfully
192 /** Build the upper/lowercase comparison table
196 /** Moves the given module to the last slot in the list
197 * @param modulename The module name to relocate
199 void MoveToLast(std::string modulename);
201 /** Moves the given module to the first slot in the list
202 * @param modulename The module name to relocate
204 void MoveToFirst(std::string modulename);
206 /** Moves one module to be placed after another in the list
207 * @param modulename The module name to relocate
208 * @param after The module name to place the module after
210 void MoveAfter(std::string modulename, std::string after);
212 /** Moves one module to be placed before another in the list
213 * @param modulename The module name to relocate
214 * @param after The module name to place the module before
216 void MoveBefore(std::string modulename, std::string before);
218 /** Process a user whos socket has been flagged as active
219 * @param cu The user to process
220 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
222 void ProcessUser(userrec* cu);
224 /** Iterate the list of InspSocket objects, removing ones which have timed out
225 * @param TIME the current time
227 void DoSocketTimeouts(time_t TIME);
229 /** Perform background user events such as PING checks
230 * @param TIME the current time
232 void DoBackgroundUserStuff(time_t TIME);
234 /** Returns true when all modules have done pre-registration checks on a user
235 * @param user The user to verify
236 * @return True if all modules have finished checking this user
238 bool AllModulesReportReady(userrec* user);
240 /** Total number of modules loaded into the ircd, minus one
244 /** Logfile pathname specified on the commandline, or empty string
246 char LogFileName[MAXBUF];
248 /** The feature names published by various modules
250 featurelist Features;
252 /** The current time, updated in the mainloop
256 /** The time that was recorded last time around the mainloop
260 /** A 64k buffer used to read client lines into
262 char ReadBuffer[65535];
264 /** Number of seconds in a minute
266 const long duration_m;
268 /** Number of seconds in an hour
270 const long duration_h;
272 /** Number of seconds in a day
274 const long duration_d;
276 /** Number of seconds in a week
278 const long duration_w;
280 /** Number of seconds in a year
282 const long duration_y;
284 /** Used when connecting clients
286 insp_sockaddr client, server;
288 /** Used when connecting clients
292 /** Used to count iterations around the mainloop
297 /** Time this ircd was booted
301 /** Mode handler, handles mode setting and removal
305 /** Command parser, handles client to server commands
307 CommandParser* Parser;
309 /** Socket engine, handles socket activity events
313 /** Stats class, holds miscellaneous stats counters
317 /** Server Config class, holds configuration file data
319 ServerConfig* Config;
321 /** Module sockets list, holds the active set of InspSocket classes
323 std::vector<InspSocket*> module_sockets;
325 /** Socket reference table, provides fast lookup of fd to InspSocket*
327 InspSocket* socket_ref[MAX_DESCRIPTORS];
329 /** user reference table, provides fast lookup of fd to userrec*
331 userrec* fd_ref_table[MAX_DESCRIPTORS];
333 /** Client list, a hash_map containing all clients, local and remote
335 user_hash clientlist;
337 /** Channel list, a hash_map containing all channels
341 /** Local client list, a vector containing only local clients
343 std::vector<userrec*> local_users;
345 /** Oper list, a vector containing all local and remote opered users
347 std::vector<userrec*> all_opers;
349 /** Whowas container, contains a map of vectors of users tracked by WHOWAS
351 irc::whowas::whowas_users whowas;
353 /** DNS class, provides resolver facilities to the core and modules
357 /** Timer manager class, triggers InspTimer timer events
359 TimerManager* Timers;
361 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
363 XLineManager* XLines;
365 /** A list of Module* module classes
366 * Note that this list is always exactly 255 in size.
367 * The actual number of loaded modules is available from GetModuleCount()
371 /** A list of ModuleFactory* module factories
372 * Note that this list is always exactly 255 in size.
373 * The actual number of loaded modules is available from GetModuleCount()
377 /** Get the current time
378 * Because this only calls time() once every time around the mainloop,
379 * it is much faster than calling time() directly.
380 * @return The current time as an epoch value (time_t)
384 /** Get the total number of currently loaded modules
385 * @return The number of loaded modules
387 int GetModuleCount();
389 /** Find a module by name, and return a Module* to it.
390 * This is preferred over iterating the module lists yourself.
391 * @param name The module name to look up
392 * @return A pointer to the module, or NULL if the module cannot be found
394 Module* FindModule(const std::string &name);
396 /** Bind all ports specified in the configuration file.
397 * @param bail True if the function should bail back to the shell on failure
398 * @return The number of ports actually bound without error
400 int BindPorts(bool bail);
402 /** Returns true if this server has the given port bound to the given address
403 * @param port The port number
404 * @param addr The address
405 * @return True if we have a port listening on this address
407 bool HasPort(int port, char* addr);
409 /** Binds a socket on an already open file descriptor
410 * @param sockfd A valid file descriptor of an open socket
411 * @param client A sockaddr to use as temporary storage
412 * @param server A sockaddr to use as temporary storage
413 * @param port The port number to bind to
414 * @param addr The address to bind to (IP only)
415 * @return True if the port was bound successfully
417 bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
419 /** Adds a server name to the list of servers we've seen
420 * @param The servername to add
422 void AddServerName(const std::string &servername);
424 /** Finds a cached char* pointer of a server name,
425 * This is used to optimize userrec by storing only the pointer to the name
426 * @param The servername to find
427 * @return A pointer to this name, gauranteed to never become invalid
429 const char* FindServerNamePtr(const std::string &servername);
431 /** Returns true if we've seen the given server name before
432 * @param The servername to find
433 * @return True if we've seen this server name before
435 bool FindServerName(const std::string &servername);
437 /** Gets the GECOS (description) field of the given server.
438 * If the servername is not that of the local server, the name
439 * is passed to handling modules which will attempt to determine
440 * the GECOS that bleongs to the given servername.
441 * @param servername The servername to find the description of
442 * @return The description of this server, or of the local server
444 std::string GetServerDescription(const char* servername);
446 /** Write text to all opers connected to this server
447 * @param text The text format string
448 * @param ... Format args
450 void WriteOpers(const char* text, ...);
452 /** Write text to all opers connected to this server
453 * @param text The text to send
455 void WriteOpers(const std::string &text);
457 /** Find a nickname in the nick hash
458 * @param nick The nickname to find
459 * @return A pointer to the user, or NULL if the user does not exist
461 userrec* FindNick(const std::string &nick);
463 /** Find a nickname in the nick hash
464 * @param nick The nickname to find
465 * @return A pointer to the user, or NULL if the user does not exist
467 userrec* FindNick(const char* nick);
469 /** Find a channel in the channels hash
470 * @param chan The channel to find
471 * @return A pointer to the channel, or NULL if the channel does not exist
473 chanrec* FindChan(const std::string &chan);
475 /** Find a channel in the channels hash
476 * @param chan The channel to find
477 * @return A pointer to the channel, or NULL if the channel does not exist
479 chanrec* FindChan(const char* chan);
481 /** Called by the constructor to load all modules from the config file.
483 void LoadAllModules();
485 /** Check for a 'die' tag in the config file, and abort if found
486 * @return Depending on the configuration, this function may never return
490 /** Check we aren't running as root, and exit if we are
491 * @return Depending on the configuration, this function may never return
495 /** Determine the right path for, and open, the logfile
496 * @param argv The argv passed to main() initially, used to calculate program path
497 * @param argc The argc passed to main() initially, used to calculate program path
499 void OpenLog(char** argv, int argc);
501 /** Convert a user to a pseudoclient, disconnecting the real user
502 * @param user The user to convert
503 * @param message The quit message to display when exiting the user
504 * @return True if the operation succeeded
506 bool UserToPseudo(userrec* user, const std::string &message);
508 /** Convert a pseudoclient to a real user, discarding the pseudoclient
509 * @param alive A live client
510 * @param zombie A pseudoclient
511 * @param message The message to display when quitting the pseudoclient
512 * @return True if the operation succeeded
514 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
516 /** Send a server notice to all local users
517 * @param text The text format string to send
518 * @param ... The format arguments
520 void ServerNoticeAll(char* text, ...);
522 /** Send a server message (PRIVMSG) to all local users
523 * @param text The text format string to send
524 * @param ... The format arguments
526 void ServerPrivmsgAll(char* text, ...);
528 /** Send text to all users with a specific set of modes
529 * @param modes The modes to check against, without a +, e.g. 'og'
530 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
531 * mode characters in the first parameter causes receipt of the message, and
532 * if you specify WM_OR, all the modes must be present.
533 * @param text The text format string to send
534 * @param ... The format arguments
536 void WriteMode(const char* modes, int flags, const char* text, ...);
538 /** Return true if a channel name is valid
539 * @param chname A channel name to verify
540 * @return True if the name is valid
542 bool IsChannel(const char *chname);
544 /** Rehash the local server
545 * @param status This value is unused, and required for signal handler functions
547 static void Rehash(int status);
549 /** Causes the server to exit immediately
550 * @param The exit code to give to the operating system
552 static void Exit(int status);
554 /** Return a count of users, unknown and known connections
555 * @return The number of users
559 /** Return a count of fully registered connections only
560 * @return The number of registered users
562 int RegisteredUserCount();
564 /** Return a count of invisible (umode +i) users only
565 * @return The number of invisible users
567 int InvisibleUserCount();
569 /** Return a count of opered (umode +o) users only
570 * @return The number of opers
574 /** Return a count of unregistered (before NICK/USER) users only
575 * @return The number of unregistered (unknown) connections
577 int UnregisteredUserCount();
579 /** Return a count of channels on the network
580 * @return The number of channels
584 /** Return a count of local users on this server only
585 * @return The number of local users
587 long LocalUserCount();
589 /** Send an error notice to all local users, opered and unopered
590 * @param s The error string to send
592 void SendError(const char *s);
594 /** For use with Module::Prioritize().
595 * When the return value of this function is returned from
596 * Module::Prioritize(), this specifies that the module wishes
597 * to be ordered exactly BEFORE 'modulename'. For more information
598 * please see Module::Prioritize().
599 * @param modulename The module your module wants to be before in the call list
600 * @returns a priority ID which the core uses to relocate the module in the list
602 long PriorityBefore(const std::string &modulename);
604 /** For use with Module::Prioritize().
605 * When the return value of this function is returned from
606 * Module::Prioritize(), this specifies that the module wishes
607 * to be ordered exactly AFTER 'modulename'. For more information please
608 * see Module::Prioritize().
609 * @param modulename The module your module wants to be after in the call list
610 * @returns a priority ID which the core uses to relocate the module in the list
612 long PriorityAfter(const std::string &modulename);
614 /** Publish a 'feature'.
615 * There are two ways for a module to find another module it depends on.
616 * Either by name, using InspIRCd::FindModule, or by feature, using this
617 * function. A feature is an arbitary string which identifies something this
618 * module can do. For example, if your module provides SSL support, but other
619 * modules provide SSL support too, all the modules supporting SSL should
620 * publish an identical 'SSL' feature. This way, any module requiring use
621 * of SSL functions can just look up the 'SSL' feature using FindFeature,
622 * then use the module pointer they are given.
623 * @param FeatureName The case sensitive feature name to make available
624 * @param Mod a pointer to your module class
625 * @returns True on success, false if the feature is already published by
628 bool PublishFeature(const std::string &FeatureName, Module* Mod);
630 /** Unpublish a 'feature'.
631 * When your module exits, it must call this method for every feature it
632 * is providing so that the feature table is cleaned up.
633 * @param FeatureName the feature to remove
635 bool UnpublishFeature(const std::string &FeatureName);
637 /** Find a 'feature'.
638 * There are two ways for a module to find another module it depends on.
639 * Either by name, using InspIRCd::FindModule, or by feature, using the
640 * InspIRCd::PublishFeature method. A feature is an arbitary string which
641 * identifies something this module can do. For example, if your module
642 * provides SSL support, but other modules provide SSL support too, all
643 * the modules supporting SSL should publish an identical 'SSL' feature.
644 * To find a module capable of providing the feature you want, simply
645 * call this method with the feature name you are looking for.
646 * @param FeatureName The feature name you wish to obtain the module for
647 * @returns A pointer to a valid module class on success, NULL on failure.
649 Module* FindFeature(const std::string &FeatureName);
651 /** Given a pointer to a Module, return its filename
652 * @param m The module pointer to identify
653 * @return The module name or an empty string
655 const std::string& GetModuleName(Module* m);
657 /** Return true if a nickname is valid
658 * @param n A nickname to verify
659 * @return True if the nick is valid
661 bool IsNick(const char* n);
663 /** Return true if an ident is valid
664 * @param An ident to verify
665 * @return True if the ident is valid
667 bool IsIdent(const char* n);
669 /** Find a username by their file descriptor.
670 * It is preferred to use this over directly accessing the fd_ref_table array.
671 * @param socket The file descriptor of a user
672 * @return A pointer to the user if the user exists locally on this descriptor
674 userrec* FindDescriptor(int socket);
676 /** Add a new mode to this server's mode parser
677 * @param mh The modehandler to add
678 * @param modechar The mode character this modehandler handles
679 * @return True if the mode handler was added
681 bool AddMode(ModeHandler* mh, const unsigned char modechar);
683 /** Add a new mode watcher to this server's mode parser
684 * @param mw The modewatcher to add
685 * @return True if the modewatcher was added
687 bool AddModeWatcher(ModeWatcher* mw);
689 /** Delete a mode watcher from this server's mode parser
690 * @param mw The modewatcher to delete
691 * @return True if the modewatcher was deleted
693 bool DelModeWatcher(ModeWatcher* mw);
695 /** Add a dns Resolver class to this server's active set
696 * @param r The resolver to add
697 * @return True if the resolver was added
699 bool AddResolver(Resolver* r);
701 /** Add a command to this server's command parser
702 * @param f A command_t command handler object to add
703 * @throw ModuleException Will throw ModuleExcption if the command already exists
705 void AddCommand(command_t *f);
707 /** Send a modechange.
708 * The parameters provided are identical to that sent to the
709 * handler for class cmd_mode.
710 * @param parameters The mode parameters
711 * @param pcnt The number of items you have given in the first parameter
712 * @param user The user to send error messages to
714 void SendMode(const char **parameters, int pcnt, userrec *user);
716 /** Match two strings using pattern matching.
717 * This operates identically to the global function match(),
718 * except for that it takes std::string arguments rather than
720 * @param sliteral The literal string to match against
721 * @param spattern The pattern to match against. CIDR and globs are supported.
723 bool MatchText(const std::string &sliteral, const std::string &spattern);
725 /** Call the handler for a given command.
726 * @param commandname The command whos handler you wish to call
727 * @param parameters The mode parameters
728 * @param pcnt The number of items you have given in the first parameter
729 * @param user The user to execute the command as
730 * @return True if the command handler was called successfully
732 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
734 /** Return true if the command is a module-implemented command and the given parameters are valid for it
735 * @param parameters The mode parameters
736 * @param pcnt The number of items you have given in the first parameter
737 * @param user The user to test-execute the command as
738 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
740 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
742 /** Add a gline and apply it
743 * @param duration How long the line should last
744 * @param source Who set the line
745 * @param reason The reason for the line
746 * @param hostmask The hostmask to set the line against
748 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
750 /** Add a qline and apply it
751 * @param duration How long the line should last
752 * @param source Who set the line
753 * @param reason The reason for the line
754 * @param nickname The nickmask to set the line against
756 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
758 /** Add a zline and apply it
759 * @param duration How long the line should last
760 * @param source Who set the line
761 * @param reason The reason for the line
762 * @param ipaddr The ip-mask to set the line against
764 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
766 /** Add a kline and apply it
767 * @param duration How long the line should last
768 * @param source Who set the line
769 * @param reason The reason for the line
770 * @param hostmask The hostmask to set the line against
772 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
775 * @param duration How long the line should last
776 * @param source Who set the line
777 * @param reason The reason for the line
778 * @param hostmask The hostmask to set the line against
780 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
783 * @param hostmask The gline to delete
784 * @return True if the item was removed
786 bool DelGLine(const std::string &hostmask);
789 * @param nickname The qline to delete
790 * @return True if the item was removed
792 bool DelQLine(const std::string &nickname);
795 * @param ipaddr The zline to delete
796 * @return True if the item was removed
798 bool DelZLine(const std::string &ipaddr);
801 * @param hostmask The kline to delete
802 * @return True if the item was removed
804 bool DelKLine(const std::string &hostmask);
807 * @param hostmask The kline to delete
808 * @return True if the item was removed
810 bool DelELine(const std::string &hostmask);
812 /** Return true if the given parameter is a valid nick!user\@host mask
813 * @param mask A nick!user\@host masak to match against
814 * @return True i the mask is valid
816 bool IsValidMask(const std::string &mask);
818 /** Add an InspSocket class to the active set
819 * @param sock A socket to add to the active set
821 void AddSocket(InspSocket* sock);
823 /** Remove an InspSocket class from the active set at next time around the loop
824 * @param sock A socket to remove from the active set
826 void RemoveSocket(InspSocket* sock);
828 /** Delete a socket immediately without waiting for the next iteration of the mainloop
829 * @param sock A socket to delete from the active set
831 void DelSocket(InspSocket* sock);
833 /** Rehash the local server
837 /** Return the channel whos index number matches that provided
838 * @param The index number of the channel to fetch
839 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
841 chanrec* GetChannelIndex(long index);
843 /** Dump text to a user target, splitting it appropriately to fit
844 * @param User the user to dump the text to
845 * @param LinePrefix text to prefix each complete line with
846 * @param TextStream the text to send to the user
848 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
850 /** Check if the given nickmask matches too many users, send errors to the given user
851 * @param nick A nickmask to match against
852 * @param user A user to send error text to
853 * @return True if the nick matches too many users
855 bool NickMatchesEveryone(const std::string &nick, userrec* user);
857 /** Check if the given IP mask matches too many users, send errors to the given user
858 * @param ip An ipmask to match against
859 * @param user A user to send error text to
860 * @return True if the ip matches too many users
862 bool IPMatchesEveryone(const std::string &ip, userrec* user);
864 /** Check if the given hostmask matches too many users, send errors to the given user
865 * @param mask A hostmask to match against
866 * @param user A user to send error text to
867 * @return True if the host matches too many users
869 bool HostMatchesEveryone(const std::string &mask, userrec* user);
871 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
872 * @param str A string containing a time in the form 1y2w3d4h6m5s
873 * (one year, two weeks, three days, four hours, six minutes and five seconds)
874 * @return The total number of seconds
876 long Duration(const char* str);
878 /** Attempt to compare an oper password to a string from the config file.
879 * This will be passed to handling modules which will compare the data
880 * against possible hashed equivalents in the input string.
881 * @param data The data from the config file
882 * @param input The data input by the oper
883 * @return 0 if the strings match, 1 or -1 if they do not
885 int OperPassCompare(const char* data,const char* input);
887 /** Check if a given server is a uline.
888 * An empty string returns true, this is by design.
889 * @param server The server to check for uline status
890 * @return True if the server is a uline OR the string is empty
892 bool ULine(const char* server);
894 /** Returns the subversion revision ID of this ircd
895 * @return The revision ID or an empty string
897 std::string GetRevision();
899 /** Returns the full version string of this ircd
900 * @return The version string
902 std::string GetVersionString();
904 /** Attempt to write the process id to a given file
905 * @param filename The PID file to attempt to write to
906 * @return This function may bail if the file cannot be written
908 void WritePID(const std::string &filename);
910 /** Returns text describing the last module error
911 * @return The last error message to occur
915 /** Load a given module file
916 * @param filename The file to load
917 * @return True if the module was found and loaded
919 bool LoadModule(const char* filename);
921 /** Unload a given module file
922 * @param filename The file to unload
923 * @return True if the module was unloaded
925 bool UnloadModule(const char* filename);
927 /** This constructor initialises all the subsystems and reads the config file.
928 * @param argc The argument count passed to main()
929 * @param argv The argument list passed to main()
930 * @throw <anything> If anything is thrown from here and makes it to
931 * you, you should probably just give up and go home. Yes, really.
932 * It's that bad. Higher level classes should catch any non-fatal exceptions.
934 InspIRCd(int argc, char** argv);
936 /** Do one iteration of the mainloop
937 * @param process_module_sockets True if module sockets are to be processed
938 * this time around the event loop. The is the default.
940 void DoOneIteration(bool process_module_sockets = true);
942 /** Output a log message to the ircd.log file
943 * The text will only be output if the current loglevel
944 * is less than or equal to the level you provide
945 * @param level A log level from the DebugLevel enum
946 * @param text Format string of to write to the log
947 * @param ... Format arguments of text to write to the log
949 void Log(int level, const char* text, ...);
951 /** Output a log message to the ircd.log file
952 * The text will only be output if the current loglevel
953 * is less than or equal to the level you provide
954 * @param level A log level from the DebugLevel enum
955 * @param text Text to write to the log
957 void Log(int level, const std::string &text);
959 /** Begin execution of the server.
960 * NOTE: this function NEVER returns. Internally,
961 * after performing some initialisation routines,
962 * it will repeatedly call DoOneIteration in a loop.
963 * @return The return value for this function is undefined.