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"
29 /** Returned by some functions to indicate failure.
33 /** Support for librodent -
34 * see http://www.chatspike.net/index.php?z=64
36 #define ETIREDHAMSTERS EAGAIN
38 /** Debug levels for use with InspIRCd::Log()
50 * This define is used in place of strcmp when we
51 * want to check if a char* string contains only one
52 * letter. Pretty fast, its just two compares and an
55 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
57 /** Delete a pointer, and NULL its value
59 template<typename T> inline void DELETE(T* x)
65 /** Template functions to convert any input type to std::string
67 template<typename T> inline std::string ConvNumeric(const T &in)
73 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
80 std::reverse(res,out);
84 inline std::string ConvToStr(const int in)
86 return ConvNumeric(in);
89 inline std::string ConvToStr(const long in)
91 return ConvNumeric(in);
94 inline std::string ConvToStr(const unsigned long in)
96 return ConvNumeric(in);
99 inline std::string ConvToStr(const char* in)
104 inline std::string ConvToStr(const bool in)
106 return (in ? "1" : "0");
109 template <class T> inline std::string ConvToStr(const T &in)
111 std::stringstream tmp;
112 if (!(tmp << in)) return std::string();
116 template<typename T> inline long ConvToInt(const T &in)
118 std::stringstream tmp;
119 if (!(tmp << in)) return 0;
120 return atoi(tmp.str().c_str());
123 /** Template function to convert integer to char, storing result in *res and
124 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
126 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
128 if (base < 2 || base > 16) { *res = 0; return res; }
132 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
136 if ( in < 0 && base == 10) *out++ = '-';
137 std::reverse( res, out );
142 /** This class contains various STATS counters
143 * It is used by the InspIRCd class, which internally
144 * has an instance of it.
146 class serverstats : public classbase
149 /** Number of accepted connections
151 unsigned long statsAccept;
152 /** Number of failed accepts
154 unsigned long statsRefused;
155 /** Number of unknown commands seen
157 unsigned long statsUnknown;
158 /** Number of nickname collisions handled
160 unsigned long statsCollisions;
161 /** Number of DNS queries sent out
163 unsigned long statsDns;
164 /** Number of good DNS replies received
165 * NOTE: This may not tally to the number sent out,
166 * due to timeouts and other latency issues.
168 unsigned long statsDnsGood;
169 /** Number of bad (negative) DNS replies received
170 * NOTE: This may not tally to the number sent out,
171 * due to timeouts and other latency issues.
173 unsigned long statsDnsBad;
174 /** Number of inbound connections seen
176 unsigned long statsConnects;
177 /** Total bytes of data transmitted
180 /** Total bytes of data received
183 /** Number of bound listening ports
185 unsigned long BoundPortCount;
187 /** Cpu usage at last sample
191 /** Time last sample was read
195 /** The constructor initializes all the counts to zero
198 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
199 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 /** Build the ISUPPORT string by triggering all modules On005Numeric events
306 void BuildISupport();
308 /** Move a given module to a specific slot in the list
309 * @param modulename The module name to relocate
310 * @param slot The slot to move the module into
312 void MoveTo(std::string modulename,int slot);
314 /** Display the startup banner
318 /** Set up the signal handlers
322 /** Daemonize the ircd and close standard input/output streams
323 * @return True if the program daemonized succesfully
327 /** Moves the given module to the last slot in the list
328 * @param modulename The module name to relocate
330 void MoveToLast(std::string modulename);
332 /** Moves the given module to the first slot in the list
333 * @param modulename The module name to relocate
335 void MoveToFirst(std::string modulename);
337 /** Moves one module to be placed after another in the list
338 * @param modulename The module name to relocate
339 * @param after The module name to place the module after
341 void MoveAfter(std::string modulename, std::string after);
343 /** Moves one module to be placed before another in the list
344 * @param modulename The module name to relocate
345 * @param after The module name to place the module before
347 void MoveBefore(std::string modulename, std::string before);
349 /** Iterate the list of InspSocket objects, removing ones which have timed out
350 * @param TIME the current time
352 void DoSocketTimeouts(time_t TIME);
354 /** Perform background user events such as PING checks
355 * @param TIME the current time
357 void DoBackgroundUserStuff(time_t TIME);
359 /** Returns true when all modules have done pre-registration checks on a user
360 * @param user The user to verify
361 * @return True if all modules have finished checking this user
363 bool AllModulesReportReady(userrec* user);
365 /** Total number of modules loaded into the ircd, minus one
369 /** Logfile pathname specified on the commandline, or empty string
371 char LogFileName[MAXBUF];
373 /** The feature names published by various modules
375 featurelist Features;
377 /** The interface names published by various modules
379 interfacelist Interfaces;
381 /** The current time, updated in the mainloop
385 /** The time that was recorded last time around the mainloop
389 /** A 64k buffer used to read client lines into
391 char ReadBuffer[65535];
393 /** Number of seconds in a minute
395 const long duration_m;
397 /** Number of seconds in an hour
399 const long duration_h;
401 /** Number of seconds in a day
403 const long duration_d;
405 /** Number of seconds in a week
407 const long duration_w;
409 /** Number of seconds in a year
411 const long duration_y;
413 /** Used when connecting clients
415 insp_sockaddr client, server;
417 /** Used when connecting clients
421 /** Nonblocking file writer
425 /** Time offset in seconds
426 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
432 /** Number of unregistered users online right now.
433 * (Unregistered means before USER/NICK/dns)
435 int unregistered_count;
437 /** List of server names we've seen.
439 servernamelist servernames;
441 /** Time this ircd was booted
445 /** Mode handler, handles mode setting and removal
449 /** Command parser, handles client to server commands
451 CommandParser* Parser;
453 /** Socket engine, handles socket activity events
457 /** Stats class, holds miscellaneous stats counters
461 /** Server Config class, holds configuration file data
463 ServerConfig* Config;
465 /** Snomask manager - handles routing of snomask messages
470 /** Client list, a hash_map containing all clients, local and remote
472 user_hash* clientlist;
474 /** Channel list, a hash_map containing all channels
478 /** Local client list, a vector containing only local clients
480 std::vector<userrec*> local_users;
482 /** Oper list, a vector containing all local and remote opered users
484 std::vector<userrec*> all_opers;
486 clonemap local_clones;
488 clonemap global_clones;
490 /** DNS class, provides resolver facilities to the core and modules
494 /** Timer manager class, triggers InspTimer timer events
496 TimerManager* Timers;
498 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
500 XLineManager* XLines;
502 /** A list of Module* module classes
503 * Note that this list is always exactly 255 in size.
504 * The actual number of loaded modules is available from GetModuleCount()
508 /** A list of ModuleFactory* module factories
509 * Note that this list is always exactly 255 in size.
510 * The actual number of loaded modules is available from GetModuleCount()
514 /** The time we next call our ping timeout and reg timeout checks
518 /** Get the current time
519 * Because this only calls time() once every time around the mainloop,
520 * it is much faster than calling time() directly.
521 * @param delta True to use the delta as an offset, false otherwise
522 * @return The current time as an epoch value (time_t)
524 time_t Time(bool delta = false);
526 /** Set the time offset in seconds
527 * This offset is added to Time() to offset the system time by the specified
529 * @param delta The number of seconds to offset
530 * @return The old time delta
532 int SetTimeDelta(int delta);
534 void AddLocalClone(userrec* user);
536 void AddGlobalClone(userrec* user);
538 /** Number of users with a certain mode set on them
540 int ModeCount(const char mode);
542 /** Get the time offset in seconds
543 * @return The current time delta (in seconds)
547 /** Process a user whos socket has been flagged as active
548 * @param cu The user to process
549 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
551 void ProcessUser(userrec* cu);
553 /** Get the total number of currently loaded modules
554 * @return The number of loaded modules
556 int GetModuleCount();
558 /** Find a module by name, and return a Module* to it.
559 * This is preferred over iterating the module lists yourself.
560 * @param name The module name to look up
561 * @return A pointer to the module, or NULL if the module cannot be found
563 Module* FindModule(const std::string &name);
565 /** Bind all ports specified in the configuration file.
566 * @param bail True if the function should bail back to the shell on failure
567 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
568 * @return The number of ports actually bound without error
570 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
572 /** Returns true if this server has the given port bound to the given address
573 * @param port The port number
574 * @param addr The address
575 * @return True if we have a port listening on this address
577 bool HasPort(int port, char* addr);
579 /** Binds a socket on an already open file descriptor
580 * @param sockfd A valid file descriptor of an open socket
581 * @param client A sockaddr to use as temporary storage
582 * @param server A sockaddr to use as temporary storage
583 * @param port The port number to bind to
584 * @param addr The address to bind to (IP only)
585 * @return True if the port was bound successfully
587 bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
589 /** Adds a server name to the list of servers we've seen
590 * @param The servername to add
592 void AddServerName(const std::string &servername);
594 /** Finds a cached char* pointer of a server name,
595 * This is used to optimize userrec by storing only the pointer to the name
596 * @param The servername to find
597 * @return A pointer to this name, gauranteed to never become invalid
599 const char* FindServerNamePtr(const std::string &servername);
601 /** Returns true if we've seen the given server name before
602 * @param The servername to find
603 * @return True if we've seen this server name before
605 bool FindServerName(const std::string &servername);
607 /** Gets the GECOS (description) field of the given server.
608 * If the servername is not that of the local server, the name
609 * is passed to handling modules which will attempt to determine
610 * the GECOS that bleongs to the given servername.
611 * @param servername The servername to find the description of
612 * @return The description of this server, or of the local server
614 std::string GetServerDescription(const char* servername);
616 /** Write text to all opers connected to this server
617 * @param text The text format string
618 * @param ... Format args
620 void WriteOpers(const char* text, ...);
622 /** Write text to all opers connected to this server
623 * @param text The text to send
625 void WriteOpers(const std::string &text);
627 /** Find a nickname in the nick hash
628 * @param nick The nickname to find
629 * @return A pointer to the user, or NULL if the user does not exist
631 userrec* FindNick(const std::string &nick);
633 /** Find a nickname in the nick hash
634 * @param nick The nickname to find
635 * @return A pointer to the user, or NULL if the user does not exist
637 userrec* FindNick(const char* nick);
639 /** Find a channel in the channels hash
640 * @param chan The channel to find
641 * @return A pointer to the channel, or NULL if the channel does not exist
643 chanrec* FindChan(const std::string &chan);
645 /** Find a channel in the channels hash
646 * @param chan The channel to find
647 * @return A pointer to the channel, or NULL if the channel does not exist
649 chanrec* FindChan(const char* chan);
651 /** Called by the constructor to load all modules from the config file.
653 void LoadAllModules();
655 /** Check for a 'die' tag in the config file, and abort if found
656 * @return Depending on the configuration, this function may never return
660 /** Check we aren't running as root, and exit if we are
661 * @return Depending on the configuration, this function may never return
665 /** Determine the right path for, and open, the logfile
666 * @param argv The argv passed to main() initially, used to calculate program path
667 * @param argc The argc passed to main() initially, used to calculate program path
669 void OpenLog(char** argv, int argc);
673 /** Convert a user to a pseudoclient, disconnecting the real user
674 * @param user The user to convert
675 * @param message The quit message to display when exiting the user
676 * @return True if the operation succeeded
678 bool UserToPseudo(userrec* user, const std::string &message);
680 /** Convert a pseudoclient to a real user, discarding the pseudoclient
681 * @param alive A live client
682 * @param zombie A pseudoclient
683 * @param message The message to display when quitting the pseudoclient
684 * @return True if the operation succeeded
686 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
688 /** Send a server notice to all local users
689 * @param text The text format string to send
690 * @param ... The format arguments
692 void ServerNoticeAll(char* text, ...);
694 /** Send a server message (PRIVMSG) to all local users
695 * @param text The text format string to send
696 * @param ... The format arguments
698 void ServerPrivmsgAll(char* text, ...);
700 /** Send text to all users with a specific set of modes
701 * @param modes The modes to check against, without a +, e.g. 'og'
702 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
703 * mode characters in the first parameter causes receipt of the message, and
704 * if you specify WM_OR, all the modes must be present.
705 * @param text The text format string to send
706 * @param ... The format arguments
708 void WriteMode(const char* modes, int flags, const char* text, ...);
710 /** Return true if a channel name is valid
711 * @param chname A channel name to verify
712 * @return True if the name is valid
714 bool IsChannel(const char *chname);
716 /** Rehash the local server
717 * @param status This value is unused, and required for signal handler functions
719 static void Rehash(int status);
721 /** Causes the server to exit immediately
722 * @param The exit code to give to the operating system
723 * (See the ExitStatus enum for valid values)
725 static void Exit(int status);
727 /** Return a count of users, unknown and known connections
728 * @return The number of users
732 /** Return a count of fully registered connections only
733 * @return The number of registered users
735 int RegisteredUserCount();
737 /** Return a count of invisible (umode +i) users only
738 * @return The number of invisible users
740 int InvisibleUserCount();
742 /** Return a count of opered (umode +o) users only
743 * @return The number of opers
747 /** Return a count of unregistered (before NICK/USER) users only
748 * @return The number of unregistered (unknown) connections
750 int UnregisteredUserCount();
752 /** Return a count of channels on the network
753 * @return The number of channels
757 /** Return a count of local users on this server only
758 * @return The number of local users
760 long LocalUserCount();
762 /** Send an error notice to all local users, opered and unopered
763 * @param s The error string to send
765 void SendError(const std::string &s);
767 /** For use with Module::Prioritize().
768 * When the return value of this function is returned from
769 * Module::Prioritize(), this specifies that the module wishes
770 * to be ordered exactly BEFORE 'modulename'. For more information
771 * please see Module::Prioritize().
772 * @param modulename The module your module wants to be before in the call list
773 * @returns a priority ID which the core uses to relocate the module in the list
775 long PriorityBefore(const std::string &modulename);
777 /** For use with Module::Prioritize().
778 * When the return value of this function is returned from
779 * Module::Prioritize(), this specifies that the module wishes
780 * to be ordered exactly AFTER 'modulename'. For more information please
781 * see Module::Prioritize().
782 * @param modulename The module your module wants to be after in the call list
783 * @returns a priority ID which the core uses to relocate the module in the list
785 long PriorityAfter(const std::string &modulename);
787 /** Publish a 'feature'.
788 * There are two ways for a module to find another module it depends on.
789 * Either by name, using InspIRCd::FindModule, or by feature, using this
790 * function. A feature is an arbitary string which identifies something this
791 * module can do. For example, if your module provides SSL support, but other
792 * modules provide SSL support too, all the modules supporting SSL should
793 * publish an identical 'SSL' feature. This way, any module requiring use
794 * of SSL functions can just look up the 'SSL' feature using FindFeature,
795 * then use the module pointer they are given.
796 * @param FeatureName The case sensitive feature name to make available
797 * @param Mod a pointer to your module class
798 * @returns True on success, false if the feature is already published by
801 bool PublishFeature(const std::string &FeatureName, Module* Mod);
803 /** Publish a module to an 'interface'.
804 * Modules which implement the same interface (the same way of communicating
805 * with other modules) can publish themselves to an interface, using this
806 * method. When they do so, they become part of a list of related or
807 * compatible modules, and a third module may then query for that list
808 * and know that all modules within that list offer the same API.
809 * A prime example of this is the hashing modules, which all accept the
810 * same types of Request class. Consider this to be similar to PublishFeature,
811 * except for that multiple modules may publish the same 'feature'.
812 * @param InterfaceName The case sensitive interface name to make available
813 * @param Mod a pointer to your module class
814 * @returns True on success, false on failure (there are currently no failure
817 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
819 /** Return a pair saying how many other modules are currently using the
820 * interfaces provided by module m.
821 * @param m The module to count usage for
822 * @return A pair, where the first value is the number of uses of the interface,
823 * and the second value is the interface name being used.
825 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
827 /** Mark your module as using an interface.
828 * If you mark your module as using an interface, then that interface
829 * module may not unload until your module has unloaded first.
830 * This can be used to prevent crashes by ensuring code you depend on
831 * is always in memory while your module is active.
832 * @param InterfaceName The interface to use
834 void UseInterface(const std::string &InterfaceName);
836 /** Mark your module as finished with an interface.
837 * If you used UseInterface() above, you should use this method when
838 * your module is finished with the interface (usually in its destructor)
839 * to allow the modules which implement the given interface to be unloaded.
840 * @param InterfaceName The interface you are finished with using.
842 void DoneWithInterface(const std::string &InterfaceName);
844 /** Unpublish a 'feature'.
845 * When your module exits, it must call this method for every feature it
846 * is providing so that the feature table is cleaned up.
847 * @param FeatureName the feature to remove
849 bool UnpublishFeature(const std::string &FeatureName);
851 /** Unpublish your module from an interface
852 * When your module exits, it must call this method for every interface
853 * it is part of so that the interfaces table is cleaned up. Only when
854 * the last item is deleted from an interface does the interface get
856 * @param InterfaceName the interface to be removed from
857 * @param Mod The module to remove from the interface list
859 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
861 /** Find a 'feature'.
862 * There are two ways for a module to find another module it depends on.
863 * Either by name, using InspIRCd::FindModule, or by feature, using the
864 * InspIRCd::PublishFeature method. A feature is an arbitary string which
865 * identifies something this module can do. For example, if your module
866 * provides SSL support, but other modules provide SSL support too, all
867 * the modules supporting SSL should publish an identical 'SSL' feature.
868 * To find a module capable of providing the feature you want, simply
869 * call this method with the feature name you are looking for.
870 * @param FeatureName The feature name you wish to obtain the module for
871 * @returns A pointer to a valid module class on success, NULL on failure.
873 Module* FindFeature(const std::string &FeatureName);
875 /** Find an 'interface'.
876 * An interface is a list of modules which all implement the same API.
877 * @param InterfaceName The Interface you wish to obtain the module
879 * @return A pointer to a deque of Module*, or NULL if the interface
882 modulelist* FindInterface(const std::string &InterfaceName);
884 /** Given a pointer to a Module, return its filename
885 * @param m The module pointer to identify
886 * @return The module name or an empty string
888 const std::string& GetModuleName(Module* m);
890 /** Return true if a nickname is valid
891 * @param n A nickname to verify
892 * @return True if the nick is valid
894 bool IsNick(const char* n);
896 /** Return true if an ident is valid
897 * @param An ident to verify
898 * @return True if the ident is valid
900 bool IsIdent(const char* n);
902 /** Find a username by their file descriptor.
903 * It is preferred to use this over directly accessing the fd_ref_table array.
904 * @param socket The file descriptor of a user
905 * @return A pointer to the user if the user exists locally on this descriptor
907 userrec* FindDescriptor(int socket);
909 /** Add a new mode to this server's mode parser
910 * @param mh The modehandler to add
911 * @param modechar The mode character this modehandler handles
912 * @return True if the mode handler was added
914 bool AddMode(ModeHandler* mh, const unsigned char modechar);
916 /** Add a new mode watcher to this server's mode parser
917 * @param mw The modewatcher to add
918 * @return True if the modewatcher was added
920 bool AddModeWatcher(ModeWatcher* mw);
922 /** Delete a mode watcher from this server's mode parser
923 * @param mw The modewatcher to delete
924 * @return True if the modewatcher was deleted
926 bool DelModeWatcher(ModeWatcher* mw);
928 /** Add a dns Resolver class to this server's active set
929 * @param r The resolver to add
930 * @param cached If this value is true, then the cache will
931 * be searched for the DNS result, immediately. If the value is
932 * false, then a request will be sent to the nameserver, and the
933 * result will not be immediately available. You should usually
934 * use the boolean value which you passed to the Resolver
935 * constructor, which Resolver will set appropriately depending
936 * on if cached results are available and haven't expired. It is
937 * however safe to force this value to false, forcing a remote DNS
938 * lookup, but not an update of the cache.
939 * @return True if the operation completed successfully. Note that
940 * if this method returns true, you should not attempt to access
941 * the resolver class you pass it after this call, as depending upon
942 * the request given, the object may be deleted!
944 bool AddResolver(Resolver* r, bool cached);
946 /** Add a command to this server's command parser
947 * @param f A command_t command handler object to add
948 * @throw ModuleException Will throw ModuleExcption if the command already exists
950 void AddCommand(command_t *f);
952 /** Send a modechange.
953 * The parameters provided are identical to that sent to the
954 * handler for class cmd_mode.
955 * @param parameters The mode parameters
956 * @param pcnt The number of items you have given in the first parameter
957 * @param user The user to send error messages to
959 void SendMode(const char **parameters, int pcnt, userrec *user);
961 /** Match two strings using pattern matching.
962 * This operates identically to the global function match(),
963 * except for that it takes std::string arguments rather than
965 * @param sliteral The literal string to match against
966 * @param spattern The pattern to match against. CIDR and globs are supported.
968 bool MatchText(const std::string &sliteral, const std::string &spattern);
970 /** Call the handler for a given command.
971 * @param commandname The command whos handler you wish to call
972 * @param parameters The mode parameters
973 * @param pcnt The number of items you have given in the first parameter
974 * @param user The user to execute the command as
975 * @return True if the command handler was called successfully
977 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
979 /** Return true if the command is a module-implemented command and the given parameters are valid for it
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 test-execute the command as
983 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
985 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
987 /** Add a gline and apply it
988 * @param duration How long the line should last
989 * @param source Who set the line
990 * @param reason The reason for the line
991 * @param hostmask The hostmask to set the line against
993 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
995 /** Add a qline 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 nickname The nickmask to set the line against
1001 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1003 /** Add a zline 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 ipaddr The ip-mask to set the line against
1009 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1011 /** Add a kline 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 hostmask The hostmask to set the line against
1017 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
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 AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1028 * @param hostmask The gline to delete
1029 * @return True if the item was removed
1031 bool DelGLine(const std::string &hostmask);
1034 * @param nickname The qline to delete
1035 * @return True if the item was removed
1037 bool DelQLine(const std::string &nickname);
1040 * @param ipaddr The zline to delete
1041 * @return True if the item was removed
1043 bool DelZLine(const std::string &ipaddr);
1046 * @param hostmask The kline to delete
1047 * @return True if the item was removed
1049 bool DelKLine(const std::string &hostmask);
1052 * @param hostmask The kline to delete
1053 * @return True if the item was removed
1055 bool DelELine(const std::string &hostmask);
1057 /** Return true if the given parameter is a valid nick!user\@host mask
1058 * @param mask A nick!user\@host masak to match against
1059 * @return True i the mask is valid
1061 bool IsValidMask(const std::string &mask);
1063 /** Rehash the local server
1065 void RehashServer();
1067 /** Return the channel whos index number matches that provided
1068 * @param The index number of the channel to fetch
1069 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1071 chanrec* GetChannelIndex(long index);
1073 /** Dump text to a user target, splitting it appropriately to fit
1074 * @param User the user to dump the text to
1075 * @param LinePrefix text to prefix each complete line with
1076 * @param TextStream the text to send to the user
1078 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1080 /** Check if the given nickmask matches too many users, send errors to the given user
1081 * @param nick A nickmask to match against
1082 * @param user A user to send error text to
1083 * @return True if the nick matches too many users
1085 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1087 /** Check if the given IP mask matches too many users, send errors to the given user
1088 * @param ip An ipmask to match against
1089 * @param user A user to send error text to
1090 * @return True if the ip matches too many users
1092 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1094 /** Check if the given hostmask matches too many users, send errors to the given user
1095 * @param mask A hostmask to match against
1096 * @param user A user to send error text to
1097 * @return True if the host matches too many users
1099 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1101 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1102 * @param str A string containing a time in the form 1y2w3d4h6m5s
1103 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1104 * @return The total number of seconds
1106 long Duration(const char* str);
1108 /** Attempt to compare an oper password to a string from the config file.
1109 * This will be passed to handling modules which will compare the data
1110 * against possible hashed equivalents in the input string.
1111 * @param data The data from the config file
1112 * @param input The data input by the oper
1113 * @param tagnum the tag number of the oper's tag in the config file
1114 * @return 0 if the strings match, 1 or -1 if they do not
1116 int OperPassCompare(const char* data,const char* input, int tagnum);
1118 /** Check if a given server is a uline.
1119 * An empty string returns true, this is by design.
1120 * @param server The server to check for uline status
1121 * @return True if the server is a uline OR the string is empty
1123 bool ULine(const char* server);
1125 /** Returns the subversion revision ID of this ircd
1126 * @return The revision ID or an empty string
1128 std::string GetRevision();
1130 /** Returns the full version string of this ircd
1131 * @return The version string
1133 std::string GetVersionString();
1135 /** Attempt to write the process id to a given file
1136 * @param filename The PID file to attempt to write to
1137 * @return This function may bail if the file cannot be written
1139 void WritePID(const std::string &filename);
1141 /** Returns text describing the last module error
1142 * @return The last error message to occur
1144 char* ModuleError();
1146 /** Load a given module file
1147 * @param filename The file to load
1148 * @return True if the module was found and loaded
1150 bool LoadModule(const char* filename);
1152 /** Unload a given module file
1153 * @param filename The file to unload
1154 * @return True if the module was unloaded
1156 bool UnloadModule(const char* filename);
1158 /** This constructor initialises all the subsystems and reads the config file.
1159 * @param argc The argument count passed to main()
1160 * @param argv The argument list passed to main()
1161 * @throw <anything> If anything is thrown from here and makes it to
1162 * you, you should probably just give up and go home. Yes, really.
1163 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1165 InspIRCd(int argc, char** argv);
1167 /** Do one iteration of the mainloop
1168 * @param process_module_sockets True if module sockets are to be processed
1169 * this time around the event loop. The is the default.
1171 void DoOneIteration(bool process_module_sockets = true);
1173 /** Output a log message to the ircd.log file
1174 * The text will only be output if the current loglevel
1175 * is less than or equal to the level you provide
1176 * @param level A log level from the DebugLevel enum
1177 * @param text Format string of to write to the log
1178 * @param ... Format arguments of text to write to the log
1180 void Log(int level, const char* text, ...);
1182 /** Output a log message to the ircd.log file
1183 * The text will only be output if the current loglevel
1184 * is less than or equal to the level you provide
1185 * @param level A log level from the DebugLevel enum
1186 * @param text Text to write to the log
1188 void Log(int level, const std::string &text);
1190 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1192 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1194 /** Restart the server.
1195 * This function will not return. If an error occurs,
1196 * it will throw an instance of CoreException.
1197 * @param reason The restart reason to show to all clients
1198 * @throw CoreException An instance of CoreException indicating the error from execv().
1200 void Restart(const std::string &reason);
1202 /** Prepare the ircd for restart or shutdown.
1203 * This function unloads all modules which can be unloaded,
1204 * closes all open sockets, and closes the logfile.
1208 /** This copies the user and channel hash_maps into new hash maps.
1209 * This frees memory used by the hash_map allocator (which it neglects
1210 * to free, most of the time, using tons of ram)
1212 void RehashUsersAndChans();
1214 /** Resets the cached max bans value on all channels.
1217 void ResetMaxBans();
1219 /** Begin execution of the server.
1220 * NOTE: this function NEVER returns. Internally,
1221 * after performing some initialisation routines,
1222 * it will repeatedly call DoOneIteration in a loop.
1223 * @return The return value for this function is undefined.