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 #define printf_c printf
22 #include "inspircd_win32wrapper.h"
23 /** Windows defines these already */
31 #include "inspircd_config.h"
36 #include "socketengine.h"
37 #include "command_parse.h"
39 #include "cull_list.h"
41 /** Returned by some functions to indicate failure.
45 /** Support for librodent -
46 * see http://www.chatspike.net/index.php?z=64
48 #define ETIREDHAMSTERS EAGAIN
50 /** Debug levels for use with InspIRCd::Log()
62 * This define is used in place of strcmp when we
63 * want to check if a char* string contains only one
64 * letter. Pretty fast, its just two compares and an
67 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
69 /** Delete a pointer, and NULL its value
71 template<typename T> inline void DELETE(T* x)
77 /** Template function to convert any input type to std::string
79 template<typename T> inline std::string ConvNumeric(const T &in)
81 if (in == 0) return "0";
86 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
93 std::reverse(res,out);
97 /** Template function to convert any input type to std::string
99 inline std::string ConvToStr(const int in)
101 return ConvNumeric(in);
104 /** Template function to convert any input type to std::string
106 inline std::string ConvToStr(const long in)
108 return ConvNumeric(in);
111 /** Template function to convert any input type to std::string
113 inline std::string ConvToStr(const unsigned long in)
115 return ConvNumeric(in);
118 /** Template function to convert any input type to std::string
120 inline std::string ConvToStr(const char* in)
125 /** Template function to convert any input type to std::string
127 inline std::string ConvToStr(const bool in)
129 return (in ? "1" : "0");
132 /** Template function to convert any input type to std::string
134 inline std::string ConvToStr(char in)
136 return std::string(in,1);
139 /** Template function to convert any input type to std::string
141 template <class T> inline std::string ConvToStr(const T &in)
143 std::stringstream tmp;
144 if (!(tmp << in)) return std::string();
148 /** Template function to convert any input type to any other type
149 * (usually an integer or numeric type)
151 template<typename T> inline long ConvToInt(const T &in)
153 std::stringstream tmp;
154 if (!(tmp << in)) return 0;
155 return atoi(tmp.str().c_str());
158 /** Template function to convert integer to char, storing result in *res and
159 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
160 * @param T input value
161 * @param V result value
162 * @param R base to convert to
164 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
166 if (base < 2 || base > 16) { *res = 0; return res; }
170 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
174 if ( in < 0 && base == 10) *out++ = '-';
175 std::reverse( res, out );
180 /** This class contains various STATS counters
181 * It is used by the InspIRCd class, which internally
182 * has an instance of it.
184 class serverstats : public classbase
187 /** Number of accepted connections
189 unsigned long statsAccept;
190 /** Number of failed accepts
192 unsigned long statsRefused;
193 /** Number of unknown commands seen
195 unsigned long statsUnknown;
196 /** Number of nickname collisions handled
198 unsigned long statsCollisions;
199 /** Number of DNS queries sent out
201 unsigned long statsDns;
202 /** Number of good DNS replies received
203 * NOTE: This may not tally to the number sent out,
204 * due to timeouts and other latency issues.
206 unsigned long statsDnsGood;
207 /** Number of bad (negative) DNS replies received
208 * NOTE: This may not tally to the number sent out,
209 * due to timeouts and other latency issues.
211 unsigned long statsDnsBad;
212 /** Number of inbound connections seen
214 unsigned long statsConnects;
215 /** Total bytes of data transmitted
218 /** Total bytes of data received
221 /** Cpu usage at last sample
224 /** Time last sample was read
227 /** The constructor initializes all the counts to zero
230 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
231 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
236 /* Forward declaration -- required */
239 /** This class implements a nonblocking log-writer.
240 * Most people writing an ircd give little thought to their disk
241 * i/o. On a congested system, disk writes can block for long
242 * periods of time (e.g. if the system is busy and/or swapping
243 * a lot). If we just use a blocking fprintf() call, this could
244 * block for undesirable amounts of time (half of a second through
245 * to whole seconds). We DO NOT want this, so we make our logfile
246 * nonblocking and hook it into the SocketEngine.
247 * NB: If the operating system does not support nonblocking file
248 * I/O (linux seems to, as does freebsd) this will default to
249 * blocking behaviour.
251 class CoreExport FileLogger : public EventHandler
254 /** The creator/owner of this object
256 InspIRCd* ServerInstance;
257 /** The log file (fd is inside this somewhere,
258 * we get it out with fileno())
261 /** Buffer of pending log lines to be written
264 /** Number of write operations that have occured
268 /** The constructor takes an already opened logfile.
270 FileLogger(InspIRCd* Instance, FILE* logfile);
271 /** This returns false, logfiles are writeable.
273 virtual bool Readable();
274 /** Handle pending write events.
275 * This will flush any waiting data to disk.
276 * If any data remains after the fprintf call,
277 * another write event is scheduled to write
278 * the rest of the data when possible.
280 virtual void HandleEvent(EventType et, int errornum = 0);
281 /** Write one or more preformatted log lines.
282 * If the data cannot be written immediately,
283 * this class will insert itself into the
284 * SocketEngine, and register a write event,
285 * and when the write event occurs it will
286 * attempt again to write the data.
288 void WriteLogLine(const std::string &line);
289 /** Close the log file and cancel any events.
291 virtual void Close();
292 /** Close the log file and cancel any events.
293 * (indirectly call Close()
295 virtual ~FileLogger();
298 /** A list of failed port bindings, used for informational purposes on startup */
299 typedef std::vector<std::pair<std::string, long> > FailedPortList;
301 /** A list of ip addresses cross referenced against clone counts */
302 typedef std::map<irc::string, unsigned int> clonemap;
304 /* Forward declaration - required */
307 /** The main class of the irc server.
308 * This class contains instances of all the other classes
309 * in this software, with the exception of the base class,
310 * classbase. Amongst other things, it contains a ModeParser,
311 * a DNS object, a CommandParser object, and a list of active
312 * Module objects, and facilities for Module objects to
313 * interact with the core system it implements. You should
314 * NEVER attempt to instantiate a class of type InspIRCd
315 * yourself. If you do, this is equivalent to spawning a second
316 * IRC server, and could have catastrophic consequences for the
317 * program in terms of ram usage (basically, you could create
318 * an obese forkbomb built from recursively spawning irc servers!)
320 class CoreExport InspIRCd : public classbase
323 /** Holds a string describing the last module error to occur
327 /** Remove a ModuleFactory pointer
328 * @param j Index number of the ModuleFactory to remove
330 void EraseFactory(int j);
332 /** Remove a Module pointer
333 * @param j Index number of the Module to remove
335 void EraseModule(int j);
337 /** Move a given module to a specific slot in the list
338 * @param modulename The module name to relocate
339 * @param slot The slot to move the module into
341 void MoveTo(std::string modulename,int slot);
343 /** Display the startup banner
347 /** Set up the signal handlers
351 /** Daemonize the ircd and close standard input/output streams
352 * @return True if the program daemonized succesfully
356 /** Moves the given module to the last slot in the list
357 * @param modulename The module name to relocate
359 void MoveToLast(std::string modulename);
361 /** Moves the given module to the first slot in the list
362 * @param modulename The module name to relocate
364 void MoveToFirst(std::string modulename);
366 /** Moves one module to be placed after another in the list
367 * @param modulename The module name to relocate
368 * @param after The module name to place the module after
370 void MoveAfter(std::string modulename, std::string after);
372 /** Moves one module to be placed before another in the list
373 * @param modulename The module name to relocate
374 * @param after The module name to place the module before
376 void MoveBefore(std::string modulename, std::string before);
378 /** Iterate the list of InspSocket objects, removing ones which have timed out
379 * @param TIME the current time
381 void DoSocketTimeouts(time_t TIME);
383 /** Perform background user events such as PING checks
384 * @param TIME the current time
386 void DoBackgroundUserStuff(time_t TIME);
388 /** Returns true when all modules have done pre-registration checks on a user
389 * @param user The user to verify
390 * @return True if all modules have finished checking this user
392 bool AllModulesReportReady(userrec* user);
394 /** Total number of modules loaded into the ircd, minus one
398 /** Logfile pathname specified on the commandline, or empty string
400 char LogFileName[MAXBUF];
402 /** The feature names published by various modules
404 featurelist Features;
406 /** The interface names published by various modules
408 interfacelist Interfaces;
410 /** The current time, updated in the mainloop
414 /** The time that was recorded last time around the mainloop
418 /** A 64k buffer used to read client lines into
420 char ReadBuffer[65535];
422 /** Used when connecting clients
424 insp_sockaddr client, server;
426 /** Used when connecting clients
430 /** Nonblocking file writer
434 /** Time offset in seconds
435 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
441 /** InspSocket classes pending deletion after being closed.
442 * We don't delete these immediately as this may cause a segmentation fault.
444 std::map<InspSocket*,InspSocket*> SocketCull;
446 /** Build the ISUPPORT string by triggering all modules On005Numeric events
448 void BuildISupport();
450 /** Number of unregistered users online right now.
451 * (Unregistered means before USER/NICK/dns)
453 int unregistered_count;
455 /** List of server names we've seen.
457 servernamelist servernames;
459 /** Time this ircd was booted
463 /** Config file pathname specified on the commandline or via ./configure
465 char ConfigFileName[MAXBUF];
467 /** Mode handler, handles mode setting and removal
471 /** Command parser, handles client to server commands
473 CommandParser* Parser;
475 /** Socket engine, handles socket activity events
479 /** Stats class, holds miscellaneous stats counters
483 /** Server Config class, holds configuration file data
485 ServerConfig* Config;
487 /** Snomask manager - handles routing of snomask messages
492 /** Client list, a hash_map containing all clients, local and remote
494 user_hash* clientlist;
496 /** Channel list, a hash_map containing all channels
500 /** Local client list, a vector containing only local clients
502 std::vector<userrec*> local_users;
504 /** Oper list, a vector containing all local and remote opered users
506 std::vector<userrec*> all_opers;
508 /** Map of local ip addresses for clone counting
510 clonemap local_clones;
512 /** Map of global ip addresses for clone counting
514 clonemap global_clones;
516 /** DNS class, provides resolver facilities to the core and modules
520 /** Timer manager class, triggers InspTimer timer events
522 TimerManager* Timers;
524 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
526 XLineManager* XLines;
528 /** A list of Module* module classes
529 * Note that this list is always exactly 255 in size.
530 * The actual number of loaded modules is available from GetModuleCount()
534 /** A list of ModuleFactory* module factories
535 * Note that this list is always exactly 255 in size.
536 * The actual number of loaded modules is available from GetModuleCount()
540 /** The time we next call our ping timeout and reg timeout checks
544 /** Global cull list, will be processed on next iteration
546 CullList GlobalCulls;
548 /** Get the current time
549 * Because this only calls time() once every time around the mainloop,
550 * it is much faster than calling time() directly.
551 * @param delta True to use the delta as an offset, false otherwise
552 * @return The current time as an epoch value (time_t)
554 time_t Time(bool delta = false);
556 /** Set the time offset in seconds
557 * This offset is added to Time() to offset the system time by the specified
559 * @param delta The number of seconds to offset
560 * @return The old time delta
562 int SetTimeDelta(int delta);
564 /** Add a user to the local clone map
565 * @param user The user to add
567 void AddLocalClone(userrec* user);
569 /** Add a user to the global clone map
570 * @param user The user to add
572 void AddGlobalClone(userrec* user);
574 /** Number of users with a certain mode set on them
576 int ModeCount(const char mode);
578 /** Get the time offset in seconds
579 * @return The current time delta (in seconds)
583 /** Process a user whos socket has been flagged as active
584 * @param cu The user to process
585 * @return There is no actual return value, however upon exit, the user 'cu' may have been
586 * marked for deletion in the global CullList.
588 void ProcessUser(userrec* cu);
590 /** Get the total number of currently loaded modules
591 * @return The number of loaded modules
593 int GetModuleCount();
595 /** Find a module by name, and return a Module* to it.
596 * This is preferred over iterating the module lists yourself.
597 * @param name The module name to look up
598 * @return A pointer to the module, or NULL if the module cannot be found
600 Module* FindModule(const std::string &name);
602 /** Bind all ports specified in the configuration file.
603 * @param bail True if the function should bail back to the shell on failure
604 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
605 * @return The number of ports actually bound without error
607 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
609 /** Binds a socket on an already open file descriptor
610 * @param sockfd A valid file descriptor of an open socket
611 * @param port The port number to bind to
612 * @param addr The address to bind to (IP only)
613 * @return True if the port was bound successfully
615 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
617 /** Adds a server name to the list of servers we've seen
618 * @param The servername to add
620 void AddServerName(const std::string &servername);
622 /** Finds a cached char* pointer of a server name,
623 * This is used to optimize userrec by storing only the pointer to the name
624 * @param The servername to find
625 * @return A pointer to this name, gauranteed to never become invalid
627 const char* FindServerNamePtr(const std::string &servername);
629 /** Returns true if we've seen the given server name before
630 * @param The servername to find
631 * @return True if we've seen this server name before
633 bool FindServerName(const std::string &servername);
635 /** Gets the GECOS (description) field of the given server.
636 * If the servername is not that of the local server, the name
637 * is passed to handling modules which will attempt to determine
638 * the GECOS that bleongs to the given servername.
639 * @param servername The servername to find the description of
640 * @return The description of this server, or of the local server
642 std::string GetServerDescription(const char* servername);
644 /** Write text to all opers connected to this server
645 * @param text The text format string
646 * @param ... Format args
648 void WriteOpers(const char* text, ...);
650 /** Write text to all opers connected to this server
651 * @param text The text to send
653 void WriteOpers(const std::string &text);
655 /** Find a nickname in the nick hash
656 * @param nick The nickname to find
657 * @return A pointer to the user, or NULL if the user does not exist
659 userrec* FindNick(const std::string &nick);
661 /** Find a nickname in the nick hash
662 * @param nick The nickname to find
663 * @return A pointer to the user, or NULL if the user does not exist
665 userrec* FindNick(const char* nick);
667 /** Find a channel in the channels hash
668 * @param chan The channel to find
669 * @return A pointer to the channel, or NULL if the channel does not exist
671 chanrec* FindChan(const std::string &chan);
673 /** Find a channel in the channels hash
674 * @param chan The channel to find
675 * @return A pointer to the channel, or NULL if the channel does not exist
677 chanrec* FindChan(const char* chan);
679 /** Called by the constructor to load all modules from the config file.
681 void LoadAllModules();
683 /** Check for a 'die' tag in the config file, and abort if found
684 * @return Depending on the configuration, this function may never return
688 /** Check we aren't running as root, and exit if we are
689 * @return Depending on the configuration, this function may never return
693 /** Determine the right path for, and open, the logfile
694 * @param argv The argv passed to main() initially, used to calculate program path
695 * @param argc The argc passed to main() initially, used to calculate program path
697 void OpenLog(char** argv, int argc);
699 /** Close the currently open log file
703 /** Send a server notice to all local users
704 * @param text The text format string to send
705 * @param ... The format arguments
707 void ServerNoticeAll(char* text, ...);
709 /** Send a server message (PRIVMSG) to all local users
710 * @param text The text format string to send
711 * @param ... The format arguments
713 void ServerPrivmsgAll(char* text, ...);
715 /** Send text to all users with a specific set of modes
716 * @param modes The modes to check against, without a +, e.g. 'og'
717 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
718 * mode characters in the first parameter causes receipt of the message, and
719 * if you specify WM_OR, all the modes must be present.
720 * @param text The text format string to send
721 * @param ... The format arguments
723 void WriteMode(const char* modes, int flags, const char* text, ...);
725 /** Return true if a channel name is valid
726 * @param chname A channel name to verify
727 * @return True if the name is valid
729 bool IsChannel(const char *chname);
731 /** Rehash the local server
732 * @param status This value is unused, and required for signal handler functions
734 static void Rehash(int status);
736 /** Causes the server to exit after unloading modules and
737 * closing all open file descriptors.
739 * @param The exit code to give to the operating system
740 * (See the ExitStatus enum for valid values)
742 static void Exit(int status);
744 /** Causes the server to exit immediately with exit code 0.
745 * The status code is required for signal handlers, and ignored.
747 static void QuickExit(int status);
749 /** Return a count of users, unknown and known connections
750 * @return The number of users
754 /** Return a count of fully registered connections only
755 * @return The number of registered users
757 int RegisteredUserCount();
759 /** Return a count of invisible (umode +i) users only
760 * @return The number of invisible users
762 int InvisibleUserCount();
764 /** Return a count of opered (umode +o) users only
765 * @return The number of opers
769 /** Return a count of unregistered (before NICK/USER) users only
770 * @return The number of unregistered (unknown) connections
772 int UnregisteredUserCount();
774 /** Return a count of channels on the network
775 * @return The number of channels
779 /** Return a count of local users on this server only
780 * @return The number of local users
782 long LocalUserCount();
784 /** Send an error notice to all local users, opered and unopered
785 * @param s The error string to send
787 void SendError(const std::string &s);
789 /** For use with Module::Prioritize().
790 * When the return value of this function is returned from
791 * Module::Prioritize(), this specifies that the module wishes
792 * to be ordered exactly BEFORE 'modulename'. For more information
793 * please see Module::Prioritize().
794 * @param modulename The module your module wants to be before in the call list
795 * @returns a priority ID which the core uses to relocate the module in the list
797 long PriorityBefore(const std::string &modulename);
799 /** For use with Module::Prioritize().
800 * When the return value of this function is returned from
801 * Module::Prioritize(), this specifies that the module wishes
802 * to be ordered exactly AFTER 'modulename'. For more information please
803 * see Module::Prioritize().
804 * @param modulename The module your module wants to be after in the call list
805 * @returns a priority ID which the core uses to relocate the module in the list
807 long PriorityAfter(const std::string &modulename);
809 /** Publish a 'feature'.
810 * There are two ways for a module to find another module it depends on.
811 * Either by name, using InspIRCd::FindModule, or by feature, using this
812 * function. A feature is an arbitary string which identifies something this
813 * module can do. For example, if your module provides SSL support, but other
814 * modules provide SSL support too, all the modules supporting SSL should
815 * publish an identical 'SSL' feature. This way, any module requiring use
816 * of SSL functions can just look up the 'SSL' feature using FindFeature,
817 * then use the module pointer they are given.
818 * @param FeatureName The case sensitive feature name to make available
819 * @param Mod a pointer to your module class
820 * @returns True on success, false if the feature is already published by
823 bool PublishFeature(const std::string &FeatureName, Module* Mod);
825 /** Publish a module to an 'interface'.
826 * Modules which implement the same interface (the same way of communicating
827 * with other modules) can publish themselves to an interface, using this
828 * method. When they do so, they become part of a list of related or
829 * compatible modules, and a third module may then query for that list
830 * and know that all modules within that list offer the same API.
831 * A prime example of this is the hashing modules, which all accept the
832 * same types of Request class. Consider this to be similar to PublishFeature,
833 * except for that multiple modules may publish the same 'feature'.
834 * @param InterfaceName The case sensitive interface name to make available
835 * @param Mod a pointer to your module class
836 * @returns True on success, false on failure (there are currently no failure
839 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
841 /** Return a pair saying how many other modules are currently using the
842 * interfaces provided by module m.
843 * @param m The module to count usage for
844 * @return A pair, where the first value is the number of uses of the interface,
845 * and the second value is the interface name being used.
847 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
849 /** Mark your module as using an interface.
850 * If you mark your module as using an interface, then that interface
851 * module may not unload until your module has unloaded first.
852 * This can be used to prevent crashes by ensuring code you depend on
853 * is always in memory while your module is active.
854 * @param InterfaceName The interface to use
856 void UseInterface(const std::string &InterfaceName);
858 /** Mark your module as finished with an interface.
859 * If you used UseInterface() above, you should use this method when
860 * your module is finished with the interface (usually in its destructor)
861 * to allow the modules which implement the given interface to be unloaded.
862 * @param InterfaceName The interface you are finished with using.
864 void DoneWithInterface(const std::string &InterfaceName);
866 /** Unpublish a 'feature'.
867 * When your module exits, it must call this method for every feature it
868 * is providing so that the feature table is cleaned up.
869 * @param FeatureName the feature to remove
871 bool UnpublishFeature(const std::string &FeatureName);
873 /** Unpublish your module from an interface
874 * When your module exits, it must call this method for every interface
875 * it is part of so that the interfaces table is cleaned up. Only when
876 * the last item is deleted from an interface does the interface get
878 * @param InterfaceName the interface to be removed from
879 * @param Mod The module to remove from the interface list
881 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
883 /** Find a 'feature'.
884 * There are two ways for a module to find another module it depends on.
885 * Either by name, using InspIRCd::FindModule, or by feature, using the
886 * InspIRCd::PublishFeature method. A feature is an arbitary string which
887 * identifies something this module can do. For example, if your module
888 * provides SSL support, but other modules provide SSL support too, all
889 * the modules supporting SSL should publish an identical 'SSL' feature.
890 * To find a module capable of providing the feature you want, simply
891 * call this method with the feature name you are looking for.
892 * @param FeatureName The feature name you wish to obtain the module for
893 * @returns A pointer to a valid module class on success, NULL on failure.
895 Module* FindFeature(const std::string &FeatureName);
897 /** Find an 'interface'.
898 * An interface is a list of modules which all implement the same API.
899 * @param InterfaceName The Interface you wish to obtain the module
901 * @return A pointer to a deque of Module*, or NULL if the interface
904 modulelist* FindInterface(const std::string &InterfaceName);
906 /** Given a pointer to a Module, return its filename
907 * @param m The module pointer to identify
908 * @return The module name or an empty string
910 const std::string& GetModuleName(Module* m);
912 /** Return true if a nickname is valid
913 * @param n A nickname to verify
914 * @return True if the nick is valid
916 bool IsNick(const char* n);
918 /** Return true if an ident is valid
919 * @param An ident to verify
920 * @return True if the ident is valid
922 bool IsIdent(const char* n);
924 /** Find a username by their file descriptor.
925 * It is preferred to use this over directly accessing the fd_ref_table array.
926 * @param socket The file descriptor of a user
927 * @return A pointer to the user if the user exists locally on this descriptor
929 userrec* FindDescriptor(int socket);
931 /** Add a new mode to this server's mode parser
932 * @param mh The modehandler to add
933 * @param modechar The mode character this modehandler handles
934 * @return True if the mode handler was added
936 bool AddMode(ModeHandler* mh, const unsigned char modechar);
938 /** Add a new mode watcher to this server's mode parser
939 * @param mw The modewatcher to add
940 * @return True if the modewatcher was added
942 bool AddModeWatcher(ModeWatcher* mw);
944 /** Delete a mode watcher from this server's mode parser
945 * @param mw The modewatcher to delete
946 * @return True if the modewatcher was deleted
948 bool DelModeWatcher(ModeWatcher* mw);
950 /** Add a dns Resolver class to this server's active set
951 * @param r The resolver to add
952 * @param cached If this value is true, then the cache will
953 * be searched for the DNS result, immediately. If the value is
954 * false, then a request will be sent to the nameserver, and the
955 * result will not be immediately available. You should usually
956 * use the boolean value which you passed to the Resolver
957 * constructor, which Resolver will set appropriately depending
958 * on if cached results are available and haven't expired. It is
959 * however safe to force this value to false, forcing a remote DNS
960 * lookup, but not an update of the cache.
961 * @return True if the operation completed successfully. Note that
962 * if this method returns true, you should not attempt to access
963 * the resolver class you pass it after this call, as depending upon
964 * the request given, the object may be deleted!
966 bool AddResolver(Resolver* r, bool cached);
968 /** Add a command to this server's command parser
969 * @param f A command_t command handler object to add
970 * @throw ModuleException Will throw ModuleExcption if the command already exists
972 void AddCommand(command_t *f);
974 /** Send a modechange.
975 * The parameters provided are identical to that sent to the
976 * handler for class cmd_mode.
977 * @param parameters The mode parameters
978 * @param pcnt The number of items you have given in the first parameter
979 * @param user The user to send error messages to
981 void SendMode(const char **parameters, int pcnt, userrec *user);
983 /** Match two strings using pattern matching.
984 * This operates identically to the global function match(),
985 * except for that it takes std::string arguments rather than
987 * @param sliteral The literal string to match against
988 * @param spattern The pattern to match against. CIDR and globs are supported.
990 bool MatchText(const std::string &sliteral, const std::string &spattern);
992 /** Call the handler for a given command.
993 * @param commandname The command whos handler you wish to call
994 * @param parameters The mode parameters
995 * @param pcnt The number of items you have given in the first parameter
996 * @param user The user to execute the command as
997 * @return True if the command handler was called successfully
999 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1001 /** Return true if the command is a module-implemented command and the given parameters are valid for it
1002 * @param parameters The mode parameters
1003 * @param pcnt The number of items you have given in the first parameter
1004 * @param user The user to test-execute the command as
1005 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
1007 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1009 /** Add a gline and apply it
1010 * @param duration How long the line should last
1011 * @param source Who set the line
1012 * @param reason The reason for the line
1013 * @param hostmask The hostmask to set the line against
1015 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1017 /** Add a qline and apply it
1018 * @param duration How long the line should last
1019 * @param source Who set the line
1020 * @param reason The reason for the line
1021 * @param nickname The nickmask to set the line against
1023 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1025 /** Add a zline and apply it
1026 * @param duration How long the line should last
1027 * @param source Who set the line
1028 * @param reason The reason for the line
1029 * @param ipaddr The ip-mask to set the line against
1031 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1033 /** Add a kline and apply it
1034 * @param duration How long the line should last
1035 * @param source Who set the line
1036 * @param reason The reason for the line
1037 * @param hostmask The hostmask to set the line against
1039 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1042 * @param duration How long the line should last
1043 * @param source Who set the line
1044 * @param reason The reason for the line
1045 * @param hostmask The hostmask to set the line against
1047 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1050 * @param hostmask The gline to delete
1051 * @return True if the item was removed
1053 bool DelGLine(const std::string &hostmask);
1056 * @param nickname The qline to delete
1057 * @return True if the item was removed
1059 bool DelQLine(const std::string &nickname);
1062 * @param ipaddr The zline to delete
1063 * @return True if the item was removed
1065 bool DelZLine(const std::string &ipaddr);
1068 * @param hostmask The kline to delete
1069 * @return True if the item was removed
1071 bool DelKLine(const std::string &hostmask);
1074 * @param hostmask The kline to delete
1075 * @return True if the item was removed
1077 bool DelELine(const std::string &hostmask);
1079 /** Return true if the given parameter is a valid nick!user\@host mask
1080 * @param mask A nick!user\@host masak to match against
1081 * @return True i the mask is valid
1083 bool IsValidMask(const std::string &mask);
1085 /** Rehash the local server
1087 void RehashServer();
1089 /** Return the channel whos index number matches that provided
1090 * @param The index number of the channel to fetch
1091 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1093 chanrec* GetChannelIndex(long index);
1095 /** Dump text to a user target, splitting it appropriately to fit
1096 * @param User the user to dump the text to
1097 * @param LinePrefix text to prefix each complete line with
1098 * @param TextStream the text to send to the user
1100 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1102 /** Check if the given nickmask matches too many users, send errors to the given user
1103 * @param nick A nickmask to match against
1104 * @param user A user to send error text to
1105 * @return True if the nick matches too many users
1107 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1109 /** Check if the given IP mask matches too many users, send errors to the given user
1110 * @param ip An ipmask to match against
1111 * @param user A user to send error text to
1112 * @return True if the ip matches too many users
1114 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1116 /** Check if the given hostmask matches too many users, send errors to the given user
1117 * @param mask A hostmask to match against
1118 * @param user A user to send error text to
1119 * @return True if the host matches too many users
1121 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1123 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1124 * @param str A string containing a time in the form 1y2w3d4h6m5s
1125 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1126 * @return The total number of seconds
1128 long Duration(const std::string &str);
1130 /** Attempt to compare an oper password to a string from the config file.
1131 * This will be passed to handling modules which will compare the data
1132 * against possible hashed equivalents in the input string.
1133 * @param data The data from the config file
1134 * @param input The data input by the oper
1135 * @param tagnum the tag number of the oper's tag in the config file
1136 * @return 0 if the strings match, 1 or -1 if they do not
1138 int OperPassCompare(const char* data,const char* input, int tagnum);
1140 /** Check if a given server is a uline.
1141 * An empty string returns true, this is by design.
1142 * @param server The server to check for uline status
1143 * @return True if the server is a uline OR the string is empty
1145 bool ULine(const char* server);
1147 /** Returns true if the uline is 'silent' (doesnt generate
1148 * remote connect notices etc).
1150 bool SilentULine(const char* server);
1152 /** Returns the subversion revision ID of this ircd
1153 * @return The revision ID or an empty string
1155 std::string GetRevision();
1157 /** Returns the full version string of this ircd
1158 * @return The version string
1160 std::string GetVersionString();
1162 /** Attempt to write the process id to a given file
1163 * @param filename The PID file to attempt to write to
1164 * @return This function may bail if the file cannot be written
1166 void WritePID(const std::string &filename);
1168 /** Returns text describing the last module error
1169 * @return The last error message to occur
1171 char* ModuleError();
1173 /** Load a given module file
1174 * @param filename The file to load
1175 * @return True if the module was found and loaded
1177 bool LoadModule(const char* filename);
1179 /** Unload a given module file
1180 * @param filename The file to unload
1181 * @return True if the module was unloaded
1183 bool UnloadModule(const char* filename);
1185 /** This constructor initialises all the subsystems and reads the config file.
1186 * @param argc The argument count passed to main()
1187 * @param argv The argument list passed to main()
1188 * @throw <anything> If anything is thrown from here and makes it to
1189 * you, you should probably just give up and go home. Yes, really.
1190 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1192 InspIRCd(int argc, char** argv);
1194 /** Do one iteration of the mainloop
1195 * @param process_module_sockets True if module sockets are to be processed
1196 * this time around the event loop. The is the default.
1198 void DoOneIteration(bool process_module_sockets = true);
1200 /** Output a log message to the ircd.log file
1201 * The text will only be output if the current loglevel
1202 * is less than or equal to the level you provide
1203 * @param level A log level from the DebugLevel enum
1204 * @param text Format string of to write to the log
1205 * @param ... Format arguments of text to write to the log
1207 void Log(int level, const char* text, ...);
1209 /** Output a log message to the ircd.log file
1210 * The text will only be output if the current loglevel
1211 * is less than or equal to the level you provide
1212 * @param level A log level from the DebugLevel enum
1213 * @param text Text to write to the log
1215 void Log(int level, const std::string &text);
1217 /** Send a line of WHOIS data to a user.
1218 * @param user user to send the line to
1219 * @param dest user being WHOISed
1220 * @param numeric Numeric to send
1221 * @param text Text of the numeric
1223 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1225 /** Send a line of WHOIS data to a user.
1226 * @param user user to send the line to
1227 * @param dest user being WHOISed
1228 * @param numeric Numeric to send
1229 * @param format Format string for the numeric
1230 * @param ... Parameters for the format string
1232 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1234 /** Quit a user for excess flood, and if they are not
1235 * fully registered yet, temporarily zline their IP.
1236 * @param current user to quit
1238 void FloodQuitUser(userrec* current);
1240 /** Restart the server.
1241 * This function will not return. If an error occurs,
1242 * it will throw an instance of CoreException.
1243 * @param reason The restart reason to show to all clients
1244 * @throw CoreException An instance of CoreException indicating the error from execv().
1246 void Restart(const std::string &reason);
1248 /** Prepare the ircd for restart or shutdown.
1249 * This function unloads all modules which can be unloaded,
1250 * closes all open sockets, and closes the logfile.
1254 /** This copies the user and channel hash_maps into new hash maps.
1255 * This frees memory used by the hash_map allocator (which it neglects
1256 * to free, most of the time, using tons of ram)
1258 void RehashUsersAndChans();
1260 /** Resets the cached max bans value on all channels.
1263 void ResetMaxBans();
1265 /** Return a time_t as a human-readable string.
1267 std::string TimeString(time_t curtime);
1269 /** Begin execution of the server.
1270 * NOTE: this function NEVER returns. Internally,
1271 * after performing some initialisation routines,
1272 * it will repeatedly call DoOneIteration in a loop.
1273 * @return The return value for this function is undefined.