1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __INSPIRCD_H__
15 #define __INSPIRCD_H__
20 #include "inspircd_config.h"
25 #include "socketengine.h"
26 #include "command_parse.h"
28 #include "cull_list.h"
30 /** Returned by some functions to indicate failure.
34 /** Support for librodent -
35 * see http://www.chatspike.net/index.php?z=64
37 #define ETIREDHAMSTERS EAGAIN
39 /** Debug levels for use with InspIRCd::Log()
51 * This define is used in place of strcmp when we
52 * want to check if a char* string contains only one
53 * letter. Pretty fast, its just two compares and an
56 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
58 /** Delete a pointer, and NULL its value
60 template<typename T> inline void DELETE(T* x)
66 /** Template functions to convert any input type to std::string
68 template<typename T> inline std::string ConvNumeric(const T &in)
70 if (in == 0) return "0";
75 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
82 std::reverse(res,out);
86 inline std::string ConvToStr(const int in)
88 return ConvNumeric(in);
91 inline std::string ConvToStr(const long in)
93 return ConvNumeric(in);
96 inline std::string ConvToStr(const unsigned long in)
98 return ConvNumeric(in);
101 inline std::string ConvToStr(const char* in)
106 inline std::string ConvToStr(const bool in)
108 return (in ? "1" : "0");
111 inline std::string ConvToStr(char in)
113 return std::string(in,1);
116 template <class T> inline std::string ConvToStr(const T &in)
118 std::stringstream tmp;
119 if (!(tmp << in)) return std::string();
123 template<typename T> inline long ConvToInt(const T &in)
125 std::stringstream tmp;
126 if (!(tmp << in)) return 0;
127 return atoi(tmp.str().c_str());
130 /** Template function to convert integer to char, storing result in *res and
131 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
133 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
135 if (base < 2 || base > 16) { *res = 0; return res; }
139 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
143 if ( in < 0 && base == 10) *out++ = '-';
144 std::reverse( res, out );
149 /** This class contains various STATS counters
150 * It is used by the InspIRCd class, which internally
151 * has an instance of it.
153 class serverstats : public classbase
156 /** Number of accepted connections
158 unsigned long statsAccept;
159 /** Number of failed accepts
161 unsigned long statsRefused;
162 /** Number of unknown commands seen
164 unsigned long statsUnknown;
165 /** Number of nickname collisions handled
167 unsigned long statsCollisions;
168 /** Number of DNS queries sent out
170 unsigned long statsDns;
171 /** Number of good DNS replies received
172 * NOTE: This may not tally to the number sent out,
173 * due to timeouts and other latency issues.
175 unsigned long statsDnsGood;
176 /** Number of bad (negative) DNS replies received
177 * NOTE: This may not tally to the number sent out,
178 * due to timeouts and other latency issues.
180 unsigned long statsDnsBad;
181 /** Number of inbound connections seen
183 unsigned long statsConnects;
184 /** Total bytes of data transmitted
187 /** Total bytes of data received
190 /** Cpu usage at last sample
193 /** Time last sample was read
196 /** The constructor initializes all the counts to zero
199 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
200 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
207 /** This class implements a nonblocking log-writer.
208 * Most people writing an ircd give little thought to their disk
209 * i/o. On a congested system, disk writes can block for long
210 * periods of time (e.g. if the system is busy and/or swapping
211 * a lot). If we just use a blocking fprintf() call, this could
212 * block for undesirable amounts of time (half of a second through
213 * to whole seconds). We DO NOT want this, so we make our logfile
214 * nonblocking and hook it into the SocketEngine.
215 * NB: If the operating system does not support nonblocking file
216 * I/O (linux seems to, as does freebsd) this will default to
217 * blocking behaviour.
219 class FileLogger : public EventHandler
222 /** The creator/owner of this object
224 InspIRCd* ServerInstance;
225 /** The log file (fd is inside this somewhere,
226 * we get it out with fileno())
229 /** Buffer of pending log lines to be written
232 /** Number of write operations that have occured
236 /** The constructor takes an already opened logfile.
238 FileLogger(InspIRCd* Instance, FILE* logfile);
239 /** This returns false, logfiles are writeable.
241 virtual bool Readable();
242 /** Handle pending write events.
243 * This will flush any waiting data to disk.
244 * If any data remains after the fprintf call,
245 * another write event is scheduled to write
246 * the rest of the data when possible.
248 virtual void HandleEvent(EventType et, int errornum = 0);
249 /** Write one or more preformatted log lines.
250 * If the data cannot be written immediately,
251 * this class will insert itself into the
252 * SocketEngine, and register a write event,
253 * and when the write event occurs it will
254 * attempt again to write the data.
256 void WriteLogLine(const std::string &line);
257 /** Close the log file and cancel any events.
259 virtual void Close();
260 /** Close the log file and cancel any events.
261 * (indirectly call Close()
263 virtual ~FileLogger();
266 /** A list of failed port bindings, used for informational purposes on startup */
267 typedef std::vector<std::pair<std::string, long> > FailedPortList;
269 /** A list of ip addresses cross referenced against clone counts */
270 typedef std::map<irc::string, unsigned int> clonemap;
274 /** The main class of the irc server.
275 * This class contains instances of all the other classes
276 * in this software, with the exception of the base class,
277 * classbase. Amongst other things, it contains a ModeParser,
278 * a DNS object, a CommandParser object, and a list of active
279 * Module objects, and facilities for Module objects to
280 * interact with the core system it implements. You should
281 * NEVER attempt to instantiate a class of type InspIRCd
282 * yourself. If you do, this is equivalent to spawning a second
283 * IRC server, and could have catastrophic consequences for the
284 * program in terms of ram usage (basically, you could create
285 * an obese forkbomb built from recursively spawning irc servers!)
287 class InspIRCd : public classbase
290 /** Holds a string describing the last module error to occur
294 /** Remove a ModuleFactory pointer
295 * @param j Index number of the ModuleFactory to remove
297 void EraseFactory(int j);
299 /** Remove a Module pointer
300 * @param j Index number of the Module to remove
302 void EraseModule(int j);
304 /** Move a given module to a specific slot in the list
305 * @param modulename The module name to relocate
306 * @param slot The slot to move the module into
308 void MoveTo(std::string modulename,int slot);
310 /** Display the startup banner
314 /** Set up the signal handlers
318 /** Daemonize the ircd and close standard input/output streams
319 * @return True if the program daemonized succesfully
323 /** Moves the given module to the last slot in the list
324 * @param modulename The module name to relocate
326 void MoveToLast(std::string modulename);
328 /** Moves the given module to the first slot in the list
329 * @param modulename The module name to relocate
331 void MoveToFirst(std::string modulename);
333 /** Moves one module to be placed after another in the list
334 * @param modulename The module name to relocate
335 * @param after The module name to place the module after
337 void MoveAfter(std::string modulename, std::string after);
339 /** Moves one module to be placed before another in the list
340 * @param modulename The module name to relocate
341 * @param after The module name to place the module before
343 void MoveBefore(std::string modulename, std::string before);
345 /** Iterate the list of InspSocket objects, removing ones which have timed out
346 * @param TIME the current time
348 void DoSocketTimeouts(time_t TIME);
350 /** Perform background user events such as PING checks
351 * @param TIME the current time
353 void DoBackgroundUserStuff(time_t TIME);
355 /** Returns true when all modules have done pre-registration checks on a user
356 * @param user The user to verify
357 * @return True if all modules have finished checking this user
359 bool AllModulesReportReady(userrec* user);
361 /** Total number of modules loaded into the ircd, minus one
365 /** Logfile pathname specified on the commandline, or empty string
367 char LogFileName[MAXBUF];
369 /** The feature names published by various modules
371 featurelist Features;
373 /** The interface names published by various modules
375 interfacelist Interfaces;
377 /** The current time, updated in the mainloop
381 /** The time that was recorded last time around the mainloop
385 /** A 64k buffer used to read client lines into
387 char ReadBuffer[65535];
389 /** Number of seconds in a minute
391 const long duration_m;
393 /** Number of seconds in an hour
395 const long duration_h;
397 /** Number of seconds in a day
399 const long duration_d;
401 /** Number of seconds in a week
403 const long duration_w;
405 /** Number of seconds in a year
407 const long duration_y;
409 /** Used when connecting clients
411 insp_sockaddr client, server;
413 /** Used when connecting clients
417 /** Nonblocking file writer
421 /** Time offset in seconds
422 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
428 std::map<InspSocket*,InspSocket*> SocketCull;
430 /** Build the ISUPPORT string by triggering all modules On005Numeric events
432 void BuildISupport();
434 /** Number of unregistered users online right now.
435 * (Unregistered means before USER/NICK/dns)
437 int unregistered_count;
439 /** List of server names we've seen.
441 servernamelist servernames;
443 /** Time this ircd was booted
447 /** Config file pathname specified on the commandline or via ./configure
449 char ConfigFileName[MAXBUF];
451 /** Mode handler, handles mode setting and removal
455 /** Command parser, handles client to server commands
457 CommandParser* Parser;
459 /** Socket engine, handles socket activity events
463 /** Stats class, holds miscellaneous stats counters
467 /** Server Config class, holds configuration file data
469 ServerConfig* Config;
471 /** Snomask manager - handles routing of snomask messages
476 /** Client list, a hash_map containing all clients, local and remote
478 user_hash* clientlist;
480 /** Channel list, a hash_map containing all channels
484 /** Local client list, a vector containing only local clients
486 std::vector<userrec*> local_users;
488 /** Oper list, a vector containing all local and remote opered users
490 std::vector<userrec*> all_opers;
492 clonemap local_clones;
494 clonemap global_clones;
496 /** DNS class, provides resolver facilities to the core and modules
500 /** Timer manager class, triggers InspTimer timer events
502 TimerManager* Timers;
504 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
506 XLineManager* XLines;
508 /** A list of Module* module classes
509 * Note that this list is always exactly 255 in size.
510 * The actual number of loaded modules is available from GetModuleCount()
514 /** A list of ModuleFactory* module factories
515 * Note that this list is always exactly 255 in size.
516 * The actual number of loaded modules is available from GetModuleCount()
520 /** The time we next call our ping timeout and reg timeout checks
524 /** Global cull list, will be processed on next iteration
526 CullList GlobalCulls;
528 /** Get the current time
529 * Because this only calls time() once every time around the mainloop,
530 * it is much faster than calling time() directly.
531 * @param delta True to use the delta as an offset, false otherwise
532 * @return The current time as an epoch value (time_t)
534 time_t Time(bool delta = false);
536 /** Set the time offset in seconds
537 * This offset is added to Time() to offset the system time by the specified
539 * @param delta The number of seconds to offset
540 * @return The old time delta
542 int SetTimeDelta(int delta);
544 void AddLocalClone(userrec* user);
546 void AddGlobalClone(userrec* user);
548 /** Number of users with a certain mode set on them
550 int ModeCount(const char mode);
552 /** Get the time offset in seconds
553 * @return The current time delta (in seconds)
557 /** Process a user whos socket has been flagged as active
558 * @param cu The user to process
559 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
561 void ProcessUser(userrec* cu);
563 /** Get the total number of currently loaded modules
564 * @return The number of loaded modules
566 int GetModuleCount();
568 /** Find a module by name, and return a Module* to it.
569 * This is preferred over iterating the module lists yourself.
570 * @param name The module name to look up
571 * @return A pointer to the module, or NULL if the module cannot be found
573 Module* FindModule(const std::string &name);
575 /** Bind all ports specified in the configuration file.
576 * @param bail True if the function should bail back to the shell on failure
577 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
578 * @return The number of ports actually bound without error
580 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
582 /** Binds a socket on an already open file descriptor
583 * @param sockfd A valid file descriptor of an open socket
584 * @param port The port number to bind to
585 * @param addr The address to bind to (IP only)
586 * @return True if the port was bound successfully
588 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
590 /** Adds a server name to the list of servers we've seen
591 * @param The servername to add
593 void AddServerName(const std::string &servername);
595 /** Finds a cached char* pointer of a server name,
596 * This is used to optimize userrec by storing only the pointer to the name
597 * @param The servername to find
598 * @return A pointer to this name, gauranteed to never become invalid
600 const char* FindServerNamePtr(const std::string &servername);
602 /** Returns true if we've seen the given server name before
603 * @param The servername to find
604 * @return True if we've seen this server name before
606 bool FindServerName(const std::string &servername);
608 /** Gets the GECOS (description) field of the given server.
609 * If the servername is not that of the local server, the name
610 * is passed to handling modules which will attempt to determine
611 * the GECOS that bleongs to the given servername.
612 * @param servername The servername to find the description of
613 * @return The description of this server, or of the local server
615 std::string GetServerDescription(const char* servername);
617 /** Write text to all opers connected to this server
618 * @param text The text format string
619 * @param ... Format args
621 void WriteOpers(const char* text, ...);
623 /** Write text to all opers connected to this server
624 * @param text The text to send
626 void WriteOpers(const std::string &text);
628 /** Find a nickname in the nick hash
629 * @param nick The nickname to find
630 * @return A pointer to the user, or NULL if the user does not exist
632 userrec* FindNick(const std::string &nick);
634 /** Find a nickname in the nick hash
635 * @param nick The nickname to find
636 * @return A pointer to the user, or NULL if the user does not exist
638 userrec* FindNick(const char* nick);
640 /** Find a channel in the channels hash
641 * @param chan The channel to find
642 * @return A pointer to the channel, or NULL if the channel does not exist
644 chanrec* FindChan(const std::string &chan);
646 /** Find a channel in the channels hash
647 * @param chan The channel to find
648 * @return A pointer to the channel, or NULL if the channel does not exist
650 chanrec* FindChan(const char* chan);
652 /** Called by the constructor to load all modules from the config file.
654 void LoadAllModules();
656 /** Check for a 'die' tag in the config file, and abort if found
657 * @return Depending on the configuration, this function may never return
661 /** Check we aren't running as root, and exit if we are
662 * @return Depending on the configuration, this function may never return
666 /** Determine the right path for, and open, the logfile
667 * @param argv The argv passed to main() initially, used to calculate program path
668 * @param argc The argc passed to main() initially, used to calculate program path
670 void OpenLog(char** argv, int argc);
674 /** Convert a user to a pseudoclient, disconnecting the real user
675 * @param user The user to convert
676 * @param message The quit message to display when exiting the user
677 * @return True if the operation succeeded
679 bool UserToPseudo(userrec* user, const std::string &message);
681 /** Convert a pseudoclient to a real user, discarding the pseudoclient
682 * @param alive A live client
683 * @param zombie A pseudoclient
684 * @param message The message to display when quitting the pseudoclient
685 * @return True if the operation succeeded
687 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
689 /** Send a server notice to all local users
690 * @param text The text format string to send
691 * @param ... The format arguments
693 void ServerNoticeAll(char* text, ...);
695 /** Send a server message (PRIVMSG) to all local users
696 * @param text The text format string to send
697 * @param ... The format arguments
699 void ServerPrivmsgAll(char* text, ...);
701 /** Send text to all users with a specific set of modes
702 * @param modes The modes to check against, without a +, e.g. 'og'
703 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
704 * mode characters in the first parameter causes receipt of the message, and
705 * if you specify WM_OR, all the modes must be present.
706 * @param text The text format string to send
707 * @param ... The format arguments
709 void WriteMode(const char* modes, int flags, const char* text, ...);
711 /** Return true if a channel name is valid
712 * @param chname A channel name to verify
713 * @return True if the name is valid
715 bool IsChannel(const char *chname);
717 /** Rehash the local server
718 * @param status This value is unused, and required for signal handler functions
720 static void Rehash(int status);
722 /** Causes the server to exit after unloading modules and
723 * closing all open file descriptors.
725 * @param The exit code to give to the operating system
726 * (See the ExitStatus enum for valid values)
728 static void Exit(int status);
730 /** Causes the server to exit immediately with exit code 0.
731 * The status code is required for signal handlers, and ignored.
733 static void QuickExit(int status);
735 /** Return a count of users, unknown and known connections
736 * @return The number of users
740 /** Return a count of fully registered connections only
741 * @return The number of registered users
743 int RegisteredUserCount();
745 /** Return a count of invisible (umode +i) users only
746 * @return The number of invisible users
748 int InvisibleUserCount();
750 /** Return a count of opered (umode +o) users only
751 * @return The number of opers
755 /** Return a count of unregistered (before NICK/USER) users only
756 * @return The number of unregistered (unknown) connections
758 int UnregisteredUserCount();
760 /** Return a count of channels on the network
761 * @return The number of channels
765 /** Return a count of local users on this server only
766 * @return The number of local users
768 long LocalUserCount();
770 /** Send an error notice to all local users, opered and unopered
771 * @param s The error string to send
773 void SendError(const std::string &s);
775 /** For use with Module::Prioritize().
776 * When the return value of this function is returned from
777 * Module::Prioritize(), this specifies that the module wishes
778 * to be ordered exactly BEFORE 'modulename'. For more information
779 * please see Module::Prioritize().
780 * @param modulename The module your module wants to be before in the call list
781 * @returns a priority ID which the core uses to relocate the module in the list
783 long PriorityBefore(const std::string &modulename);
785 /** For use with Module::Prioritize().
786 * When the return value of this function is returned from
787 * Module::Prioritize(), this specifies that the module wishes
788 * to be ordered exactly AFTER 'modulename'. For more information please
789 * see Module::Prioritize().
790 * @param modulename The module your module wants to be after in the call list
791 * @returns a priority ID which the core uses to relocate the module in the list
793 long PriorityAfter(const std::string &modulename);
795 /** Publish a 'feature'.
796 * There are two ways for a module to find another module it depends on.
797 * Either by name, using InspIRCd::FindModule, or by feature, using this
798 * function. A feature is an arbitary string which identifies something this
799 * module can do. For example, if your module provides SSL support, but other
800 * modules provide SSL support too, all the modules supporting SSL should
801 * publish an identical 'SSL' feature. This way, any module requiring use
802 * of SSL functions can just look up the 'SSL' feature using FindFeature,
803 * then use the module pointer they are given.
804 * @param FeatureName The case sensitive feature name to make available
805 * @param Mod a pointer to your module class
806 * @returns True on success, false if the feature is already published by
809 bool PublishFeature(const std::string &FeatureName, Module* Mod);
811 /** Publish a module to an 'interface'.
812 * Modules which implement the same interface (the same way of communicating
813 * with other modules) can publish themselves to an interface, using this
814 * method. When they do so, they become part of a list of related or
815 * compatible modules, and a third module may then query for that list
816 * and know that all modules within that list offer the same API.
817 * A prime example of this is the hashing modules, which all accept the
818 * same types of Request class. Consider this to be similar to PublishFeature,
819 * except for that multiple modules may publish the same 'feature'.
820 * @param InterfaceName The case sensitive interface name to make available
821 * @param Mod a pointer to your module class
822 * @returns True on success, false on failure (there are currently no failure
825 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
827 /** Return a pair saying how many other modules are currently using the
828 * interfaces provided by module m.
829 * @param m The module to count usage for
830 * @return A pair, where the first value is the number of uses of the interface,
831 * and the second value is the interface name being used.
833 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
835 /** Mark your module as using an interface.
836 * If you mark your module as using an interface, then that interface
837 * module may not unload until your module has unloaded first.
838 * This can be used to prevent crashes by ensuring code you depend on
839 * is always in memory while your module is active.
840 * @param InterfaceName The interface to use
842 void UseInterface(const std::string &InterfaceName);
844 /** Mark your module as finished with an interface.
845 * If you used UseInterface() above, you should use this method when
846 * your module is finished with the interface (usually in its destructor)
847 * to allow the modules which implement the given interface to be unloaded.
848 * @param InterfaceName The interface you are finished with using.
850 void DoneWithInterface(const std::string &InterfaceName);
852 /** Unpublish a 'feature'.
853 * When your module exits, it must call this method for every feature it
854 * is providing so that the feature table is cleaned up.
855 * @param FeatureName the feature to remove
857 bool UnpublishFeature(const std::string &FeatureName);
859 /** Unpublish your module from an interface
860 * When your module exits, it must call this method for every interface
861 * it is part of so that the interfaces table is cleaned up. Only when
862 * the last item is deleted from an interface does the interface get
864 * @param InterfaceName the interface to be removed from
865 * @param Mod The module to remove from the interface list
867 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
869 /** Find a 'feature'.
870 * There are two ways for a module to find another module it depends on.
871 * Either by name, using InspIRCd::FindModule, or by feature, using the
872 * InspIRCd::PublishFeature method. A feature is an arbitary string which
873 * identifies something this module can do. For example, if your module
874 * provides SSL support, but other modules provide SSL support too, all
875 * the modules supporting SSL should publish an identical 'SSL' feature.
876 * To find a module capable of providing the feature you want, simply
877 * call this method with the feature name you are looking for.
878 * @param FeatureName The feature name you wish to obtain the module for
879 * @returns A pointer to a valid module class on success, NULL on failure.
881 Module* FindFeature(const std::string &FeatureName);
883 /** Find an 'interface'.
884 * An interface is a list of modules which all implement the same API.
885 * @param InterfaceName The Interface you wish to obtain the module
887 * @return A pointer to a deque of Module*, or NULL if the interface
890 modulelist* FindInterface(const std::string &InterfaceName);
892 /** Given a pointer to a Module, return its filename
893 * @param m The module pointer to identify
894 * @return The module name or an empty string
896 const std::string& GetModuleName(Module* m);
898 /** Return true if a nickname is valid
899 * @param n A nickname to verify
900 * @return True if the nick is valid
902 bool IsNick(const char* n);
904 /** Return true if an ident is valid
905 * @param An ident to verify
906 * @return True if the ident is valid
908 bool IsIdent(const char* n);
910 /** Find a username by their file descriptor.
911 * It is preferred to use this over directly accessing the fd_ref_table array.
912 * @param socket The file descriptor of a user
913 * @return A pointer to the user if the user exists locally on this descriptor
915 userrec* FindDescriptor(int socket);
917 /** Add a new mode to this server's mode parser
918 * @param mh The modehandler to add
919 * @param modechar The mode character this modehandler handles
920 * @return True if the mode handler was added
922 bool AddMode(ModeHandler* mh, const unsigned char modechar);
924 /** Add a new mode watcher to this server's mode parser
925 * @param mw The modewatcher to add
926 * @return True if the modewatcher was added
928 bool AddModeWatcher(ModeWatcher* mw);
930 /** Delete a mode watcher from this server's mode parser
931 * @param mw The modewatcher to delete
932 * @return True if the modewatcher was deleted
934 bool DelModeWatcher(ModeWatcher* mw);
936 /** Add a dns Resolver class to this server's active set
937 * @param r The resolver to add
938 * @param cached If this value is true, then the cache will
939 * be searched for the DNS result, immediately. If the value is
940 * false, then a request will be sent to the nameserver, and the
941 * result will not be immediately available. You should usually
942 * use the boolean value which you passed to the Resolver
943 * constructor, which Resolver will set appropriately depending
944 * on if cached results are available and haven't expired. It is
945 * however safe to force this value to false, forcing a remote DNS
946 * lookup, but not an update of the cache.
947 * @return True if the operation completed successfully. Note that
948 * if this method returns true, you should not attempt to access
949 * the resolver class you pass it after this call, as depending upon
950 * the request given, the object may be deleted!
952 bool AddResolver(Resolver* r, bool cached);
954 /** Add a command to this server's command parser
955 * @param f A command_t command handler object to add
956 * @throw ModuleException Will throw ModuleExcption if the command already exists
958 void AddCommand(command_t *f);
960 /** Send a modechange.
961 * The parameters provided are identical to that sent to the
962 * handler for class cmd_mode.
963 * @param parameters The mode parameters
964 * @param pcnt The number of items you have given in the first parameter
965 * @param user The user to send error messages to
967 void SendMode(const char **parameters, int pcnt, userrec *user);
969 /** Match two strings using pattern matching.
970 * This operates identically to the global function match(),
971 * except for that it takes std::string arguments rather than
973 * @param sliteral The literal string to match against
974 * @param spattern The pattern to match against. CIDR and globs are supported.
976 bool MatchText(const std::string &sliteral, const std::string &spattern);
978 /** Call the handler for a given command.
979 * @param commandname The command whos handler you wish to call
980 * @param parameters The mode parameters
981 * @param pcnt The number of items you have given in the first parameter
982 * @param user The user to execute the command as
983 * @return True if the command handler was called successfully
985 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
987 /** Return true if the command is a module-implemented command and the given parameters are valid for it
988 * @param parameters The mode parameters
989 * @param pcnt The number of items you have given in the first parameter
990 * @param user The user to test-execute the command as
991 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
993 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
995 /** Add a gline and apply it
996 * @param duration How long the line should last
997 * @param source Who set the line
998 * @param reason The reason for the line
999 * @param hostmask The hostmask to set the line against
1001 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1003 /** Add a qline and apply it
1004 * @param duration How long the line should last
1005 * @param source Who set the line
1006 * @param reason The reason for the line
1007 * @param nickname The nickmask to set the line against
1009 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1011 /** Add a zline and apply it
1012 * @param duration How long the line should last
1013 * @param source Who set the line
1014 * @param reason The reason for the line
1015 * @param ipaddr The ip-mask to set the line against
1017 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1019 /** Add a kline and apply it
1020 * @param duration How long the line should last
1021 * @param source Who set the line
1022 * @param reason The reason for the line
1023 * @param hostmask The hostmask to set the line against
1025 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1028 * @param duration How long the line should last
1029 * @param source Who set the line
1030 * @param reason The reason for the line
1031 * @param hostmask The hostmask to set the line against
1033 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1036 * @param hostmask The gline to delete
1037 * @return True if the item was removed
1039 bool DelGLine(const std::string &hostmask);
1042 * @param nickname The qline to delete
1043 * @return True if the item was removed
1045 bool DelQLine(const std::string &nickname);
1048 * @param ipaddr The zline to delete
1049 * @return True if the item was removed
1051 bool DelZLine(const std::string &ipaddr);
1054 * @param hostmask The kline to delete
1055 * @return True if the item was removed
1057 bool DelKLine(const std::string &hostmask);
1060 * @param hostmask The kline to delete
1061 * @return True if the item was removed
1063 bool DelELine(const std::string &hostmask);
1065 /** Return true if the given parameter is a valid nick!user\@host mask
1066 * @param mask A nick!user\@host masak to match against
1067 * @return True i the mask is valid
1069 bool IsValidMask(const std::string &mask);
1071 /** Rehash the local server
1073 void RehashServer();
1075 /** Return the channel whos index number matches that provided
1076 * @param The index number of the channel to fetch
1077 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1079 chanrec* GetChannelIndex(long index);
1081 /** Dump text to a user target, splitting it appropriately to fit
1082 * @param User the user to dump the text to
1083 * @param LinePrefix text to prefix each complete line with
1084 * @param TextStream the text to send to the user
1086 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1088 /** Check if the given nickmask matches too many users, send errors to the given user
1089 * @param nick A nickmask to match against
1090 * @param user A user to send error text to
1091 * @return True if the nick matches too many users
1093 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1095 /** Check if the given IP mask matches too many users, send errors to the given user
1096 * @param ip An ipmask to match against
1097 * @param user A user to send error text to
1098 * @return True if the ip matches too many users
1100 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1102 /** Check if the given hostmask matches too many users, send errors to the given user
1103 * @param mask A hostmask to match against
1104 * @param user A user to send error text to
1105 * @return True if the host matches too many users
1107 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1109 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1110 * @param str A string containing a time in the form 1y2w3d4h6m5s
1111 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1112 * @return The total number of seconds
1114 long Duration(const char* str);
1116 /** Attempt to compare an oper password to a string from the config file.
1117 * This will be passed to handling modules which will compare the data
1118 * against possible hashed equivalents in the input string.
1119 * @param data The data from the config file
1120 * @param input The data input by the oper
1121 * @param tagnum the tag number of the oper's tag in the config file
1122 * @return 0 if the strings match, 1 or -1 if they do not
1124 int OperPassCompare(const char* data,const char* input, int tagnum);
1126 /** Check if a given server is a uline.
1127 * An empty string returns true, this is by design.
1128 * @param server The server to check for uline status
1129 * @return True if the server is a uline OR the string is empty
1131 bool ULine(const char* server);
1133 /** Returns true if the uline is 'silent' (doesnt generate
1134 * remote connect notices etc).
1136 bool SilentULine(const char* server);
1138 /** Returns the subversion revision ID of this ircd
1139 * @return The revision ID or an empty string
1141 std::string GetRevision();
1143 /** Returns the full version string of this ircd
1144 * @return The version string
1146 std::string GetVersionString();
1148 /** Attempt to write the process id to a given file
1149 * @param filename The PID file to attempt to write to
1150 * @return This function may bail if the file cannot be written
1152 void WritePID(const std::string &filename);
1154 /** Returns text describing the last module error
1155 * @return The last error message to occur
1157 char* ModuleError();
1159 /** Load a given module file
1160 * @param filename The file to load
1161 * @return True if the module was found and loaded
1163 bool LoadModule(const char* filename);
1165 /** Unload a given module file
1166 * @param filename The file to unload
1167 * @return True if the module was unloaded
1169 bool UnloadModule(const char* filename);
1171 /** This constructor initialises all the subsystems and reads the config file.
1172 * @param argc The argument count passed to main()
1173 * @param argv The argument list passed to main()
1174 * @throw <anything> If anything is thrown from here and makes it to
1175 * you, you should probably just give up and go home. Yes, really.
1176 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1178 InspIRCd(int argc, char** argv);
1180 /** Do one iteration of the mainloop
1181 * @param process_module_sockets True if module sockets are to be processed
1182 * this time around the event loop. The is the default.
1184 void DoOneIteration(bool process_module_sockets = true);
1186 /** Output a log message to the ircd.log file
1187 * The text will only be output if the current loglevel
1188 * is less than or equal to the level you provide
1189 * @param level A log level from the DebugLevel enum
1190 * @param text Format string of to write to the log
1191 * @param ... Format arguments of text to write to the log
1193 void Log(int level, const char* text, ...);
1195 /** Output a log message to the ircd.log file
1196 * The text will only be output if the current loglevel
1197 * is less than or equal to the level you provide
1198 * @param level A log level from the DebugLevel enum
1199 * @param text Text to write to the log
1201 void Log(int level, const std::string &text);
1203 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1205 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1207 /** Restart the server.
1208 * This function will not return. If an error occurs,
1209 * it will throw an instance of CoreException.
1210 * @param reason The restart reason to show to all clients
1211 * @throw CoreException An instance of CoreException indicating the error from execv().
1213 void Restart(const std::string &reason);
1215 /** Prepare the ircd for restart or shutdown.
1216 * This function unloads all modules which can be unloaded,
1217 * closes all open sockets, and closes the logfile.
1221 /** This copies the user and channel hash_maps into new hash maps.
1222 * This frees memory used by the hash_map allocator (which it neglects
1223 * to free, most of the time, using tons of ram)
1225 void RehashUsersAndChans();
1227 /** Resets the cached max bans value on all channels.
1230 void ResetMaxBans();
1232 /** Return a time_t as a human-readable string.
1234 std::string TimeString(time_t curtime);
1236 /** Begin execution of the server.
1237 * NOTE: this function NEVER returns. Internally,
1238 * after performing some initialisation routines,
1239 * it will repeatedly call DoOneIteration in a loop.
1240 * @return The return value for this function is undefined.