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"
37 #include "socketengine.h"
38 #include "command_parse.h"
40 #include "cull_list.h"
41 #include "filelogger.h"
45 * Used to define the maximum number of parameters a command may have.
47 #define MAXPARAMETERS 127
49 /** Returned by some functions to indicate failure.
53 /** Support for librodent -
54 * see http://www.chatspike.net/index.php?z=64
56 #define ETIREDHAMSTERS EAGAIN
58 /** Delete a pointer, and NULL its value
60 template<typename T> inline void DELETE(T* x)
66 /** Template function 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 /** Template function to convert any input type to std::string
88 inline std::string ConvToStr(const int in)
90 return ConvNumeric(in);
93 /** Template function to convert any input type to std::string
95 inline std::string ConvToStr(const long in)
97 return ConvNumeric(in);
100 /** Template function to convert any input type to std::string
102 inline std::string ConvToStr(const unsigned long in)
104 return ConvNumeric(in);
107 /** Template function to convert any input type to std::string
109 inline std::string ConvToStr(const char* in)
114 /** Template function to convert any input type to std::string
116 inline std::string ConvToStr(const bool in)
118 return (in ? "1" : "0");
121 /** Template function to convert any input type to std::string
123 inline std::string ConvToStr(char in)
125 return std::string(in,1);
128 /** Template function to convert any input type to std::string
130 template <class T> inline std::string ConvToStr(const T &in)
132 std::stringstream tmp;
133 if (!(tmp << in)) return std::string();
137 /** Template function to convert any input type to any other type
138 * (usually an integer or numeric type)
140 template<typename T> inline long ConvToInt(const T &in)
142 std::stringstream tmp;
143 if (!(tmp << in)) return 0;
144 return atoi(tmp.str().c_str());
147 /** Template function to convert integer to char, storing result in *res and
148 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
149 * @param T input value
150 * @param V result value
151 * @param R base to convert to
153 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
155 if (base < 2 || base > 16) { *res = 0; return res; }
159 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
163 if ( in < 0 && base == 10) *out++ = '-';
164 std::reverse( res, out );
169 /** This class contains various STATS counters
170 * It is used by the InspIRCd class, which internally
171 * has an instance of it.
173 class serverstats : public classbase
176 /** Number of accepted connections
178 unsigned long statsAccept;
179 /** Number of failed accepts
181 unsigned long statsRefused;
182 /** Number of unknown commands seen
184 unsigned long statsUnknown;
185 /** Number of nickname collisions handled
187 unsigned long statsCollisions;
188 /** Number of DNS queries sent out
190 unsigned long statsDns;
191 /** Number of good DNS replies received
192 * NOTE: This may not tally to the number sent out,
193 * due to timeouts and other latency issues.
195 unsigned long statsDnsGood;
196 /** Number of bad (negative) DNS replies received
197 * NOTE: This may not tally to the number sent out,
198 * due to timeouts and other latency issues.
200 unsigned long statsDnsBad;
201 /** Number of inbound connections seen
203 unsigned long statsConnects;
204 /** Total bytes of data transmitted
207 /** Total bytes of data received
210 /** Cpu usage at last sample
213 /** Time last sample was read
216 /** The constructor initializes all the counts to zero
219 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
220 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
225 /** A list of failed port bindings, used for informational purposes on startup */
226 typedef std::vector<std::pair<std::string, long> > FailedPortList;
228 /** A list of ip addresses cross referenced against clone counts */
229 typedef std::map<irc::string, unsigned int> clonemap;
233 DEFINE_HANDLER1(ProcessUserHandler, void, userrec*);
234 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
235 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
236 DEFINE_HANDLER1(FindDescriptorHandler, userrec*, int);
237 DEFINE_HANDLER1(FloodQuitUserHandler, void, userrec*);
239 /* Forward declaration - required */
242 /** The main class of the irc server.
243 * This class contains instances of all the other classes
244 * in this software, with the exception of the base class,
245 * classbase. Amongst other things, it contains a ModeParser,
246 * a DNS object, a CommandParser object, and a list of active
247 * Module objects, and facilities for Module objects to
248 * interact with the core system it implements. You should
249 * NEVER attempt to instantiate a class of type InspIRCd
250 * yourself. If you do, this is equivalent to spawning a second
251 * IRC server, and could have catastrophic consequences for the
252 * program in terms of ram usage (basically, you could create
253 * an obese forkbomb built from recursively spawning irc servers!)
255 class CoreExport InspIRCd : public classbase
258 /** Holds the current UID. Used to generate the next one.
260 char current_uid[UUID_LENGTH];
262 /** Holds a string describing the last module error to occur
266 /** Remove a ModuleFactory pointer
267 * @param j Index number of the ModuleFactory to remove
269 void EraseFactory(int j);
271 /** Remove a Module pointer
272 * @param j Index number of the Module to remove
274 void EraseModule(int j);
276 /** Move a given module to a specific slot in the list
277 * @param modulename The module name to relocate
278 * @param slot The slot to move the module into
280 void MoveTo(std::string modulename,int slot);
282 /** Set up the signal handlers
286 /** Daemonize the ircd and close standard input/output streams
287 * @return True if the program daemonized succesfully
291 /** Moves the given module to the last slot in the list
292 * @param modulename The module name to relocate
294 void MoveToLast(std::string modulename);
296 /** Moves the given module to the first slot in the list
297 * @param modulename The module name to relocate
299 void MoveToFirst(std::string modulename);
301 /** Moves one module to be placed after another in the list
302 * @param modulename The module name to relocate
303 * @param after The module name to place the module after
305 void MoveAfter(std::string modulename, std::string after);
307 /** Moves one module to be placed before another in the list
308 * @param modulename The module name to relocate
309 * @param after The module name to place the module before
311 void MoveBefore(std::string modulename, std::string before);
313 /** Iterate the list of InspSocket objects, removing ones which have timed out
314 * @param TIME the current time
316 void DoSocketTimeouts(time_t TIME);
318 /** Perform background user events such as PING checks
319 * @param TIME the current time
321 void DoBackgroundUserStuff(time_t TIME);
323 /** Returns true when all modules have done pre-registration checks on a user
324 * @param user The user to verify
325 * @return True if all modules have finished checking this user
327 bool AllModulesReportReady(userrec* user);
329 /** Total number of modules loaded into the ircd, minus one
333 /** Logfile pathname specified on the commandline, or empty string
335 char LogFileName[MAXBUF];
337 /** The feature names published by various modules
339 featurelist Features;
341 /** The interface names published by various modules
343 interfacelist Interfaces;
345 /** The current time, updated in the mainloop
349 /** The time that was recorded last time around the mainloop
353 /** A 64k buffer used to read client lines into
355 char ReadBuffer[65535];
357 /** Used when connecting clients
359 insp_sockaddr client, server;
361 /** Used when connecting clients
365 /** Nonblocking file writer
369 /** Time offset in seconds
370 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
380 /** Global cull list, will be processed on next iteration
382 CullList GlobalCulls;
387 ProcessUserHandler HandleProcessUser;
388 IsNickHandler HandleIsNick;
389 IsIdentHandler HandleIsIdent;
390 FindDescriptorHandler HandleFindDescriptor;
391 FloodQuitUserHandler HandleFloodQuitUser;
393 /** InspSocket classes pending deletion after being closed.
394 * We don't delete these immediately as this may cause a segmentation fault.
396 std::map<InspSocket*,InspSocket*> SocketCull;
398 /** Returns the next available UID for this server.
400 std::string GetUID();
402 /** Find a user in the UUID hash
403 * @param nick The nickname to find
404 * @return A pointer to the user, or NULL if the user does not exist
406 userrec *FindUUID(const std::string &);
408 /** Find a user in the UUID hash
409 * @param nick The nickname to find
410 * @return A pointer to the user, or NULL if the user does not exist
412 userrec *FindUUID(const char *);
414 /** Build the ISUPPORT string by triggering all modules On005Numeric events
416 void BuildISupport();
418 /** Number of unregistered users online right now.
419 * (Unregistered means before USER/NICK/dns)
421 int unregistered_count;
423 /** List of server names we've seen.
425 servernamelist servernames;
427 /** Time this ircd was booted
431 /** Config file pathname specified on the commandline or via ./configure
433 char ConfigFileName[MAXBUF];
435 /** Mode handler, handles mode setting and removal
439 /** Command parser, handles client to server commands
441 CommandParser* Parser;
443 /** Socket engine, handles socket activity events
447 /** Stats class, holds miscellaneous stats counters
451 /** Server Config class, holds configuration file data
453 ServerConfig* Config;
455 /** Snomask manager - handles routing of snomask messages
460 /** Client list, a hash_map containing all clients, local and remote
462 user_hash* clientlist;
464 /** Client list stored by UUID. Contains all clients, and is updated
465 * automatically by the constructor and destructor of userrec.
469 /** Channel list, a hash_map containing all channels
473 /** Local client list, a vector containing only local clients
475 std::vector<userrec*> local_users;
477 /** Oper list, a vector containing all local and remote opered users
479 std::vector<userrec*> all_opers;
481 /** Map of local ip addresses for clone counting
483 clonemap local_clones;
485 /** Map of global ip addresses for clone counting
487 clonemap global_clones;
489 /** DNS class, provides resolver facilities to the core and modules
493 /** Timer manager class, triggers InspTimer timer events
495 TimerManager* Timers;
497 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
499 XLineManager* XLines;
501 /** A list of Module* module classes
502 * Note that this list is always exactly 255 in size.
503 * The actual number of loaded modules is available from GetModuleCount()
507 /** A list of ModuleFactory* module factories
508 * Note that this list is always exactly 255 in size.
509 * The actual number of loaded modules is available from GetModuleCount()
513 /** The time we next call our ping timeout and reg timeout checks
517 /** Set to the current signal recieved
521 /** Get the current time
522 * Because this only calls time() once every time around the mainloop,
523 * it is much faster than calling time() directly.
524 * @param delta True to use the delta as an offset, false otherwise
525 * @return The current time as an epoch value (time_t)
527 time_t Time(bool delta = false);
529 /** Set the time offset in seconds
530 * This offset is added to Time() to offset the system time by the specified
532 * @param delta The number of seconds to offset
533 * @return The old time delta
535 int SetTimeDelta(int delta);
537 /** Add a user to the local clone map
538 * @param user The user to add
540 void AddLocalClone(userrec* user);
542 /** Add a user to the global clone map
543 * @param user The user to add
545 void AddGlobalClone(userrec* user);
547 /** Number of users with a certain mode set on them
549 int ModeCount(const char mode);
551 /** Get the time offset in seconds
552 * @return The current time delta (in seconds)
556 /** Process a user whos socket has been flagged as active
557 * @param cu The user to process
558 * @return There is no actual return value, however upon exit, the user 'cu' may have been
559 * marked for deletion in the global CullList.
561 caller1<void, userrec*> ProcessUser;
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 user in the nick hash.
629 * If the user cant be found in the nick hash check the uuid hash
630 * @param nick The nickname to find
631 * @return A pointer to the user, or NULL if the user does not exist
633 userrec* FindNick(const std::string &nick);
635 /** Find a user in the nick hash.
636 * If the user cant be found in the nick hash check the uuid hash
637 * @param nick The nickname to find
638 * @return A pointer to the user, or NULL if the user does not exist
640 userrec* FindNick(const char* nick);
642 /** Find a user in the nick hash ONLY
644 userrec* FindNickOnly(const char* nick);
646 /** Find a user in the nick hash ONLY
648 userrec* FindNickOnly(const std::string &nick);
650 /** Find a channel in the channels hash
651 * @param chan The channel to find
652 * @return A pointer to the channel, or NULL if the channel does not exist
654 chanrec* FindChan(const std::string &chan);
656 /** Find a channel in the channels hash
657 * @param chan The channel to find
658 * @return A pointer to the channel, or NULL if the channel does not exist
660 chanrec* FindChan(const char* chan);
662 /** Called by the constructor to load all modules from the config file.
664 void LoadAllModules();
666 /** Check for a 'die' tag in the config file, and abort if found
667 * @return Depending on the configuration, this function may never return
671 /** Check we aren't running as root, and exit if we are
672 * @return Depending on the configuration, this function may never return
676 /** Determine the right path for, and open, the logfile
677 * @param argv The argv passed to main() initially, used to calculate program path
678 * @param argc The argc passed to main() initially, used to calculate program path
679 * @return True if the log could be opened, false if otherwise
681 bool OpenLog(char** argv, int argc);
683 /** Close the currently open log file
687 /** Send a server notice to all local users
688 * @param text The text format string to send
689 * @param ... The format arguments
691 void ServerNoticeAll(char* text, ...);
693 /** Send a server message (PRIVMSG) to all local users
694 * @param text The text format string to send
695 * @param ... The format arguments
697 void ServerPrivmsgAll(char* text, ...);
699 /** Send text to all users with a specific set of modes
700 * @param modes The modes to check against, without a +, e.g. 'og'
701 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
702 * mode characters in the first parameter causes receipt of the message, and
703 * if you specify WM_OR, all the modes must be present.
704 * @param text The text format string to send
705 * @param ... The format arguments
707 void WriteMode(const char* modes, int flags, const char* text, ...);
709 /** Return true if a channel name is valid
710 * @param chname A channel name to verify
711 * @return True if the name is valid
713 bool IsChannel(const char *chname);
715 /** Rehash the local server
719 /** Handles incoming signals after being set
720 * @param signal the signal recieved
722 void SignalHandler(int signal);
724 /** Sets the signal recieved
725 * @param signal the signal recieved
727 static void SetSignal(int signal);
729 /** Causes the server to exit after unloading modules and
730 * closing all open file descriptors.
732 * @param The exit code to give to the operating system
733 * (See the ExitStatus enum for valid values)
735 void Exit(int status);
737 /** Causes the server to exit immediately with exit code 0.
738 * The status code is required for signal handlers, and ignored.
740 static void QuickExit(int status);
742 /** Return a count of users, unknown and known connections
743 * @return The number of users
747 /** Return a count of fully registered connections only
748 * @return The number of registered users
750 int RegisteredUserCount();
752 /** Return a count of invisible (umode +i) users only
753 * @return The number of invisible users
755 int InvisibleUserCount();
757 /** Return a count of opered (umode +o) users only
758 * @return The number of opers
762 /** Return a count of unregistered (before NICK/USER) users only
763 * @return The number of unregistered (unknown) connections
765 int UnregisteredUserCount();
767 /** Return a count of channels on the network
768 * @return The number of channels
772 /** Return a count of local users on this server only
773 * @return The number of local users
775 long LocalUserCount();
777 /** Send an error notice to all local users, opered and unopered
778 * @param s The error string to send
780 void SendError(const std::string &s);
782 /** For use with Module::Prioritize().
783 * When the return value of this function is returned from
784 * Module::Prioritize(), this specifies that the module wishes
785 * to be ordered exactly BEFORE 'modulename'. For more information
786 * please see Module::Prioritize().
787 * @param modulename The module your module wants to be before in the call list
788 * @returns a priority ID which the core uses to relocate the module in the list
790 long PriorityBefore(const std::string &modulename);
792 /** For use with Module::Prioritize().
793 * When the return value of this function is returned from
794 * Module::Prioritize(), this specifies that the module wishes
795 * to be ordered exactly AFTER 'modulename'. For more information please
796 * see Module::Prioritize().
797 * @param modulename The module your module wants to be after in the call list
798 * @returns a priority ID which the core uses to relocate the module in the list
800 long PriorityAfter(const std::string &modulename);
802 /** Publish a 'feature'.
803 * There are two ways for a module to find another module it depends on.
804 * Either by name, using InspIRCd::FindModule, or by feature, using this
805 * function. A feature is an arbitary string which identifies something this
806 * module can do. For example, if your module provides SSL support, but other
807 * modules provide SSL support too, all the modules supporting SSL should
808 * publish an identical 'SSL' feature. This way, any module requiring use
809 * of SSL functions can just look up the 'SSL' feature using FindFeature,
810 * then use the module pointer they are given.
811 * @param FeatureName The case sensitive feature name to make available
812 * @param Mod a pointer to your module class
813 * @returns True on success, false if the feature is already published by
816 bool PublishFeature(const std::string &FeatureName, Module* Mod);
818 /** Publish a module to an 'interface'.
819 * Modules which implement the same interface (the same way of communicating
820 * with other modules) can publish themselves to an interface, using this
821 * method. When they do so, they become part of a list of related or
822 * compatible modules, and a third module may then query for that list
823 * and know that all modules within that list offer the same API.
824 * A prime example of this is the hashing modules, which all accept the
825 * same types of Request class. Consider this to be similar to PublishFeature,
826 * except for that multiple modules may publish the same 'feature'.
827 * @param InterfaceName The case sensitive interface name to make available
828 * @param Mod a pointer to your module class
829 * @returns True on success, false on failure (there are currently no failure
832 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
834 /** Return a pair saying how many other modules are currently using the
835 * interfaces provided by module m.
836 * @param m The module to count usage for
837 * @return A pair, where the first value is the number of uses of the interface,
838 * and the second value is the interface name being used.
840 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
842 /** Mark your module as using an interface.
843 * If you mark your module as using an interface, then that interface
844 * module may not unload until your module has unloaded first.
845 * This can be used to prevent crashes by ensuring code you depend on
846 * is always in memory while your module is active.
847 * @param InterfaceName The interface to use
849 void UseInterface(const std::string &InterfaceName);
851 /** Mark your module as finished with an interface.
852 * If you used UseInterface() above, you should use this method when
853 * your module is finished with the interface (usually in its destructor)
854 * to allow the modules which implement the given interface to be unloaded.
855 * @param InterfaceName The interface you are finished with using.
857 void DoneWithInterface(const std::string &InterfaceName);
859 /** Unpublish a 'feature'.
860 * When your module exits, it must call this method for every feature it
861 * is providing so that the feature table is cleaned up.
862 * @param FeatureName the feature to remove
864 bool UnpublishFeature(const std::string &FeatureName);
866 /** Unpublish your module from an interface
867 * When your module exits, it must call this method for every interface
868 * it is part of so that the interfaces table is cleaned up. Only when
869 * the last item is deleted from an interface does the interface get
871 * @param InterfaceName the interface to be removed from
872 * @param Mod The module to remove from the interface list
874 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
876 /** Find a 'feature'.
877 * There are two ways for a module to find another module it depends on.
878 * Either by name, using InspIRCd::FindModule, or by feature, using the
879 * InspIRCd::PublishFeature method. A feature is an arbitary string which
880 * identifies something this module can do. For example, if your module
881 * provides SSL support, but other modules provide SSL support too, all
882 * the modules supporting SSL should publish an identical 'SSL' feature.
883 * To find a module capable of providing the feature you want, simply
884 * call this method with the feature name you are looking for.
885 * @param FeatureName The feature name you wish to obtain the module for
886 * @returns A pointer to a valid module class on success, NULL on failure.
888 Module* FindFeature(const std::string &FeatureName);
890 /** Find an 'interface'.
891 * An interface is a list of modules which all implement the same API.
892 * @param InterfaceName The Interface you wish to obtain the module
894 * @return A pointer to a deque of Module*, or NULL if the interface
897 modulelist* FindInterface(const std::string &InterfaceName);
899 /** Given a pointer to a Module, return its filename
900 * @param m The module pointer to identify
901 * @return The module name or an empty string
903 const std::string& GetModuleName(Module* m);
905 /** Return true if a nickname is valid
906 * @param n A nickname to verify
907 * @return True if the nick is valid
909 caller1<bool, const char*> IsNick;
911 /** Return true if an ident is valid
912 * @param An ident to verify
913 * @return True if the ident is valid
915 caller1<bool, const char*> IsIdent;
917 /** Find a username by their file descriptor.
918 * It is preferred to use this over directly accessing the fd_ref_table array.
919 * @param socket The file descriptor of a user
920 * @return A pointer to the user if the user exists locally on this descriptor
922 caller1<userrec*, int> FindDescriptor;
924 /** Add a new mode to this server's mode parser
925 * @param mh The modehandler to add
926 * @param modechar The mode character this modehandler handles
927 * @return True if the mode handler was added
929 bool AddMode(ModeHandler* mh, const unsigned char modechar);
931 /** Add a new mode watcher to this server's mode parser
932 * @param mw The modewatcher to add
933 * @return True if the modewatcher was added
935 bool AddModeWatcher(ModeWatcher* mw);
937 /** Delete a mode watcher from this server's mode parser
938 * @param mw The modewatcher to delete
939 * @return True if the modewatcher was deleted
941 bool DelModeWatcher(ModeWatcher* mw);
943 /** Add a dns Resolver class to this server's active set
944 * @param r The resolver to add
945 * @param cached If this value is true, then the cache will
946 * be searched for the DNS result, immediately. If the value is
947 * false, then a request will be sent to the nameserver, and the
948 * result will not be immediately available. You should usually
949 * use the boolean value which you passed to the Resolver
950 * constructor, which Resolver will set appropriately depending
951 * on if cached results are available and haven't expired. It is
952 * however safe to force this value to false, forcing a remote DNS
953 * lookup, but not an update of the cache.
954 * @return True if the operation completed successfully. Note that
955 * if this method returns true, you should not attempt to access
956 * the resolver class you pass it after this call, as depending upon
957 * the request given, the object may be deleted!
959 bool AddResolver(Resolver* r, bool cached);
961 /** Add a command to this server's command parser
962 * @param f A command_t command handler object to add
963 * @throw ModuleException Will throw ModuleExcption if the command already exists
965 void AddCommand(command_t *f);
967 /** Send a modechange.
968 * The parameters provided are identical to that sent to the
969 * handler for class cmd_mode.
970 * @param parameters The mode parameters
971 * @param pcnt The number of items you have given in the first parameter
972 * @param user The user to send error messages to
974 void SendMode(const char **parameters, int pcnt, userrec *user);
976 /** Match two strings using pattern matching.
977 * This operates identically to the global function match(),
978 * except for that it takes std::string arguments rather than
980 * @param sliteral The literal string to match against
981 * @param spattern The pattern to match against. CIDR and globs are supported.
983 bool MatchText(const std::string &sliteral, const std::string &spattern);
985 /** Call the handler for a given command.
986 * @param commandname The command whos handler you wish to call
987 * @param parameters The mode parameters
988 * @param pcnt The number of items you have given in the first parameter
989 * @param user The user to execute the command as
990 * @return True if the command handler was called successfully
992 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
994 /** Return true if the command is a module-implemented command and the given parameters are valid for it
995 * @param parameters The mode parameters
996 * @param pcnt The number of items you have given in the first parameter
997 * @param user The user to test-execute the command as
998 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
1000 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1002 /** Add a gline and apply it
1003 * @param duration How long the line should last
1004 * @param source Who set the line
1005 * @param reason The reason for the line
1006 * @param hostmask The hostmask to set the line against
1008 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1010 /** Add a qline and apply it
1011 * @param duration How long the line should last
1012 * @param source Who set the line
1013 * @param reason The reason for the line
1014 * @param nickname The nickmask to set the line against
1016 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1018 /** Add a zline and apply it
1019 * @param duration How long the line should last
1020 * @param source Who set the line
1021 * @param reason The reason for the line
1022 * @param ipaddr The ip-mask to set the line against
1024 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1026 /** Add a kline and apply it
1027 * @param duration How long the line should last
1028 * @param source Who set the line
1029 * @param reason The reason for the line
1030 * @param hostmask The hostmask to set the line against
1032 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1035 * @param duration How long the line should last
1036 * @param source Who set the line
1037 * @param reason The reason for the line
1038 * @param hostmask The hostmask to set the line against
1040 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1043 * @param hostmask The gline to delete
1044 * @return True if the item was removed
1046 bool DelGLine(const std::string &hostmask);
1049 * @param nickname The qline to delete
1050 * @return True if the item was removed
1052 bool DelQLine(const std::string &nickname);
1055 * @param ipaddr The zline to delete
1056 * @return True if the item was removed
1058 bool DelZLine(const std::string &ipaddr);
1061 * @param hostmask The kline to delete
1062 * @return True if the item was removed
1064 bool DelKLine(const std::string &hostmask);
1067 * @param hostmask The kline to delete
1068 * @return True if the item was removed
1070 bool DelELine(const std::string &hostmask);
1072 /** Return true if the given parameter is a valid nick!user\@host mask
1073 * @param mask A nick!user\@host masak to match against
1074 * @return True i the mask is valid
1076 bool IsValidMask(const std::string &mask);
1078 /** Rehash the local server
1080 void RehashServer();
1082 /** Return the channel whos index number matches that provided
1083 * @param The index number of the channel to fetch
1084 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1086 chanrec* GetChannelIndex(long index);
1088 /** Dump text to a user target, splitting it appropriately to fit
1089 * @param User the user to dump the text to
1090 * @param LinePrefix text to prefix each complete line with
1091 * @param TextStream the text to send to the user
1093 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1095 /** Check if the given nickmask matches too many users, send errors to the given user
1096 * @param nick A nickmask to match against
1097 * @param user A user to send error text to
1098 * @return True if the nick matches too many users
1100 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1102 /** Check if the given IP mask matches too many users, send errors to the given user
1103 * @param ip An ipmask to match against
1104 * @param user A user to send error text to
1105 * @return True if the ip matches too many users
1107 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1109 /** Check if the given hostmask matches too many users, send errors to the given user
1110 * @param mask A hostmask to match against
1111 * @param user A user to send error text to
1112 * @return True if the host matches too many users
1114 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1116 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1117 * @param str A string containing a time in the form 1y2w3d4h6m5s
1118 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1119 * @return The total number of seconds
1121 long Duration(const std::string &str);
1123 /** Attempt to compare an oper password to a string from the config file.
1124 * This will be passed to handling modules which will compare the data
1125 * against possible hashed equivalents in the input string.
1126 * @param data The data from the config file
1127 * @param input The data input by the oper
1128 * @param tagnum the tag number of the oper's tag in the config file
1129 * @return 0 if the strings match, 1 or -1 if they do not
1131 int OperPassCompare(const char* data,const char* input, int tagnum);
1133 /** Check if a given server is a uline.
1134 * An empty string returns true, this is by design.
1135 * @param server The server to check for uline status
1136 * @return True if the server is a uline OR the string is empty
1138 bool ULine(const char* server);
1140 /** Returns true if the uline is 'silent' (doesnt generate
1141 * remote connect notices etc).
1143 bool SilentULine(const char* server);
1145 /** Returns the subversion revision ID of this ircd
1146 * @return The revision ID or an empty string
1148 std::string GetRevision();
1150 /** Returns the full version string of this ircd
1151 * @return The version string
1153 std::string GetVersionString();
1155 /** Attempt to write the process id to a given file
1156 * @param filename The PID file to attempt to write to
1157 * @return This function may bail if the file cannot be written
1159 void WritePID(const std::string &filename);
1161 /** Returns text describing the last module error
1162 * @return The last error message to occur
1164 char* ModuleError();
1166 /** Load a given module file
1167 * @param filename The file to load
1168 * @return True if the module was found and loaded
1170 bool LoadModule(const char* filename);
1172 /** Unload a given module file
1173 * @param filename The file to unload
1174 * @return True if the module was unloaded
1176 bool UnloadModule(const char* filename);
1178 /** This constructor initialises all the subsystems and reads the config file.
1179 * @param argc The argument count passed to main()
1180 * @param argv The argument list passed to main()
1181 * @throw <anything> If anything is thrown from here and makes it to
1182 * you, you should probably just give up and go home. Yes, really.
1183 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1185 InspIRCd(int argc, char** argv);
1187 /** Do one iteration of the mainloop
1188 * @param process_module_sockets True if module sockets are to be processed
1189 * this time around the event loop. The is the default.
1191 void DoOneIteration(bool process_module_sockets = true);
1193 /** Output a log message to the ircd.log file
1194 * The text will only be output if the current loglevel
1195 * is less than or equal to the level you provide
1196 * @param level A log level from the DebugLevel enum
1197 * @param text Format string of to write to the log
1198 * @param ... Format arguments of text to write to the log
1200 void Log(int level, const char* text, ...);
1202 /** Output a log message to the ircd.log file
1203 * The text will only be output if the current loglevel
1204 * is less than or equal to the level you provide
1205 * @param level A log level from the DebugLevel enum
1206 * @param text Text to write to the log
1208 void Log(int level, const std::string &text);
1210 /** Send a line of WHOIS data to a user.
1211 * @param user user to send the line to
1212 * @param dest user being WHOISed
1213 * @param numeric Numeric to send
1214 * @param text Text of the numeric
1216 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1218 /** Send a line of WHOIS data to a user.
1219 * @param user user to send the line to
1220 * @param dest user being WHOISed
1221 * @param numeric Numeric to send
1222 * @param format Format string for the numeric
1223 * @param ... Parameters for the format string
1225 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1227 /** Quit a user for excess flood, and if they are not
1228 * fully registered yet, temporarily zline their IP.
1229 * @param current user to quit
1231 caller1<void, userrec*> FloodQuitUser;
1233 /** Restart the server.
1234 * This function will not return. If an error occurs,
1235 * it will throw an instance of CoreException.
1236 * @param reason The restart reason to show to all clients
1237 * @throw CoreException An instance of CoreException indicating the error from execv().
1239 void Restart(const std::string &reason);
1241 /** Prepare the ircd for restart or shutdown.
1242 * This function unloads all modules which can be unloaded,
1243 * closes all open sockets, and closes the logfile.
1247 /** This copies the user and channel hash_maps into new hash maps.
1248 * This frees memory used by the hash_map allocator (which it neglects
1249 * to free, most of the time, using tons of ram)
1251 void RehashUsersAndChans();
1253 /** Resets the cached max bans value on all channels.
1256 void ResetMaxBans();
1258 /** Return a time_t as a human-readable string.
1260 std::string TimeString(time_t curtime);
1262 /** Begin execution of the server.
1263 * NOTE: this function NEVER returns. Internally,
1264 * after performing some initialisation routines,
1265 * it will repeatedly call DoOneIteration in a loop.
1266 * @return The return value for this function is undefined.
1270 /** Force all InspSockets to be removed which are due to
1273 void InspSocketCull();
1275 char* GetReadBuffer()
1277 return this->ReadBuffer;