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"
40 #include "filelogger.h"
44 * Used to define the maximum number of parameters a command may have.
46 #define MAXPARAMETERS 127
48 /** Returned by some functions to indicate failure.
52 /** Support for librodent -
53 * see http://www.chatspike.net/index.php?z=64
55 #define ETIREDHAMSTERS EAGAIN
58 * This define is used in place of strcmp when we
59 * want to check if a char* string contains only one
60 * letter. Pretty fast, its just two compares and an
63 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
67 /** Delete a pointer, and NULL its value
69 template<typename T> inline void DELETE(T* x)
75 /** Template function to convert any input type to std::string
77 template<typename T> inline std::string ConvNumeric(const T &in)
79 if (in == 0) return "0";
84 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
91 std::reverse(res,out);
95 /** Template function to convert any input type to std::string
97 inline std::string ConvToStr(const int in)
99 return ConvNumeric(in);
102 /** Template function to convert any input type to std::string
104 inline std::string ConvToStr(const long in)
106 return ConvNumeric(in);
109 /** Template function to convert any input type to std::string
111 inline std::string ConvToStr(const unsigned long in)
113 return ConvNumeric(in);
116 /** Template function to convert any input type to std::string
118 inline std::string ConvToStr(const char* in)
123 /** Template function to convert any input type to std::string
125 inline std::string ConvToStr(const bool in)
127 return (in ? "1" : "0");
130 /** Template function to convert any input type to std::string
132 inline std::string ConvToStr(char in)
134 return std::string(in,1);
137 /** Template function to convert any input type to std::string
139 template <class T> inline std::string ConvToStr(const T &in)
141 std::stringstream tmp;
142 if (!(tmp << in)) return std::string();
146 /** Template function to convert any input type to any other type
147 * (usually an integer or numeric type)
149 template<typename T> inline long ConvToInt(const T &in)
151 std::stringstream tmp;
152 if (!(tmp << in)) return 0;
153 return atoi(tmp.str().c_str());
156 /** Template function to convert integer to char, storing result in *res and
157 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
158 * @param T input value
159 * @param V result value
160 * @param R base to convert to
162 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
164 if (base < 2 || base > 16) { *res = 0; return res; }
168 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
172 if ( in < 0 && base == 10) *out++ = '-';
173 std::reverse( res, out );
178 /** This class contains various STATS counters
179 * It is used by the InspIRCd class, which internally
180 * has an instance of it.
182 class serverstats : public classbase
185 /** Number of accepted connections
187 unsigned long statsAccept;
188 /** Number of failed accepts
190 unsigned long statsRefused;
191 /** Number of unknown commands seen
193 unsigned long statsUnknown;
194 /** Number of nickname collisions handled
196 unsigned long statsCollisions;
197 /** Number of DNS queries sent out
199 unsigned long statsDns;
200 /** Number of good DNS replies received
201 * NOTE: This may not tally to the number sent out,
202 * due to timeouts and other latency issues.
204 unsigned long statsDnsGood;
205 /** Number of bad (negative) DNS replies received
206 * NOTE: This may not tally to the number sent out,
207 * due to timeouts and other latency issues.
209 unsigned long statsDnsBad;
210 /** Number of inbound connections seen
212 unsigned long statsConnects;
213 /** Total bytes of data transmitted
216 /** Total bytes of data received
219 /** Cpu usage at last sample
222 /** Time last sample was read
225 /** The constructor initializes all the counts to zero
228 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
229 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
234 /** A list of failed port bindings, used for informational purposes on startup */
235 typedef std::vector<std::pair<std::string, long> > FailedPortList;
237 /** A list of ip addresses cross referenced against clone counts */
238 typedef std::map<irc::string, unsigned int> clonemap;
242 class CoreExport IsNickHandler : public HandlerBase1<bool, const char*>
246 IsNickHandler(InspIRCd* Srv) : Server(Srv) { }
247 virtual ~IsNickHandler() { }
248 virtual bool Call(const char*);
251 class CoreExport IsIdentHandler : public HandlerBase1<bool, const char*>
255 IsIdentHandler(InspIRCd* Srv) : Server(Srv) { }
256 virtual ~IsIdentHandler() { }
257 virtual bool Call(const char*);
261 /* Forward declaration - required */
264 /** The main class of the irc server.
265 * This class contains instances of all the other classes
266 * in this software, with the exception of the base class,
267 * classbase. Amongst other things, it contains a ModeParser,
268 * a DNS object, a CommandParser object, and a list of active
269 * Module objects, and facilities for Module objects to
270 * interact with the core system it implements. You should
271 * NEVER attempt to instantiate a class of type InspIRCd
272 * yourself. If you do, this is equivalent to spawning a second
273 * IRC server, and could have catastrophic consequences for the
274 * program in terms of ram usage (basically, you could create
275 * an obese forkbomb built from recursively spawning irc servers!)
277 class CoreExport InspIRCd : public classbase
280 /** Holds a string describing the last module error to occur
284 /** Remove a ModuleFactory pointer
285 * @param j Index number of the ModuleFactory to remove
287 void EraseFactory(int j);
289 /** Remove a Module pointer
290 * @param j Index number of the Module to remove
292 void EraseModule(int j);
294 /** Move a given module to a specific slot in the list
295 * @param modulename The module name to relocate
296 * @param slot The slot to move the module into
298 void MoveTo(std::string modulename,int slot);
300 /** Set up the signal handlers
304 /** Daemonize the ircd and close standard input/output streams
305 * @return True if the program daemonized succesfully
309 /** Moves the given module to the last slot in the list
310 * @param modulename The module name to relocate
312 void MoveToLast(std::string modulename);
314 /** Moves the given module to the first slot in the list
315 * @param modulename The module name to relocate
317 void MoveToFirst(std::string modulename);
319 /** Moves one module to be placed after another in the list
320 * @param modulename The module name to relocate
321 * @param after The module name to place the module after
323 void MoveAfter(std::string modulename, std::string after);
325 /** Moves one module to be placed before another in the list
326 * @param modulename The module name to relocate
327 * @param after The module name to place the module before
329 void MoveBefore(std::string modulename, std::string before);
331 /** Iterate the list of InspSocket objects, removing ones which have timed out
332 * @param TIME the current time
334 void DoSocketTimeouts(time_t TIME);
336 /** Perform background user events such as PING checks
337 * @param TIME the current time
339 void DoBackgroundUserStuff(time_t TIME);
341 /** Returns true when all modules have done pre-registration checks on a user
342 * @param user The user to verify
343 * @return True if all modules have finished checking this user
345 bool AllModulesReportReady(userrec* user);
347 /** Total number of modules loaded into the ircd, minus one
351 /** Logfile pathname specified on the commandline, or empty string
353 char LogFileName[MAXBUF];
355 /** The feature names published by various modules
357 featurelist Features;
359 /** The interface names published by various modules
361 interfacelist Interfaces;
363 /** The current time, updated in the mainloop
367 /** The time that was recorded last time around the mainloop
371 /** A 64k buffer used to read client lines into
373 char ReadBuffer[65535];
375 /** Used when connecting clients
377 insp_sockaddr client, server;
379 /** Used when connecting clients
383 /** Nonblocking file writer
387 /** Time offset in seconds
388 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
394 /** Global cull list, will be processed on next iteration
396 CullList GlobalCulls;
401 IsNickHandler HandleIsNick;
403 IsIdentHandler HandleIsIdent;
405 /** InspSocket classes pending deletion after being closed.
406 * We don't delete these immediately as this may cause a segmentation fault.
408 std::map<InspSocket*,InspSocket*> SocketCull;
410 /** Build the ISUPPORT string by triggering all modules On005Numeric events
412 void BuildISupport();
414 /** Number of unregistered users online right now.
415 * (Unregistered means before USER/NICK/dns)
417 int unregistered_count;
419 /** List of server names we've seen.
421 servernamelist servernames;
423 /** Time this ircd was booted
427 /** Config file pathname specified on the commandline or via ./configure
429 char ConfigFileName[MAXBUF];
431 /** Mode handler, handles mode setting and removal
435 /** Command parser, handles client to server commands
437 CommandParser* Parser;
439 /** Socket engine, handles socket activity events
443 /** Stats class, holds miscellaneous stats counters
447 /** Server Config class, holds configuration file data
449 ServerConfig* Config;
451 /** Snomask manager - handles routing of snomask messages
456 /** Client list, a hash_map containing all clients, local and remote
458 user_hash* clientlist;
460 /** Channel list, a hash_map containing all channels
464 /** Local client list, a vector containing only local clients
466 std::vector<userrec*> local_users;
468 /** Oper list, a vector containing all local and remote opered users
470 std::vector<userrec*> all_opers;
472 /** Map of local ip addresses for clone counting
474 clonemap local_clones;
476 /** Map of global ip addresses for clone counting
478 clonemap global_clones;
480 /** DNS class, provides resolver facilities to the core and modules
484 /** Timer manager class, triggers InspTimer timer events
486 TimerManager* Timers;
488 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
490 XLineManager* XLines;
492 /** A list of Module* module classes
493 * Note that this list is always exactly 255 in size.
494 * The actual number of loaded modules is available from GetModuleCount()
498 /** A list of ModuleFactory* module factories
499 * Note that this list is always exactly 255 in size.
500 * The actual number of loaded modules is available from GetModuleCount()
504 /** The time we next call our ping timeout and reg timeout checks
508 /** Get the current time
509 * Because this only calls time() once every time around the mainloop,
510 * it is much faster than calling time() directly.
511 * @param delta True to use the delta as an offset, false otherwise
512 * @return The current time as an epoch value (time_t)
514 time_t Time(bool delta = false);
516 /** Set the time offset in seconds
517 * This offset is added to Time() to offset the system time by the specified
519 * @param delta The number of seconds to offset
520 * @return The old time delta
522 int SetTimeDelta(int delta);
524 /** Add a user to the local clone map
525 * @param user The user to add
527 void AddLocalClone(userrec* user);
529 /** Add a user to the global clone map
530 * @param user The user to add
532 void AddGlobalClone(userrec* user);
534 /** Number of users with a certain mode set on them
536 int ModeCount(const char mode);
538 /** Get the time offset in seconds
539 * @return The current time delta (in seconds)
543 /** Process a user whos socket has been flagged as active
544 * @param cu The user to process
545 * @return There is no actual return value, however upon exit, the user 'cu' may have been
546 * marked for deletion in the global CullList.
548 void ProcessUser(userrec* cu);
550 /** Get the total number of currently loaded modules
551 * @return The number of loaded modules
553 int GetModuleCount();
555 /** Find a module by name, and return a Module* to it.
556 * This is preferred over iterating the module lists yourself.
557 * @param name The module name to look up
558 * @return A pointer to the module, or NULL if the module cannot be found
560 Module* FindModule(const std::string &name);
562 /** Bind all ports specified in the configuration file.
563 * @param bail True if the function should bail back to the shell on failure
564 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
565 * @return The number of ports actually bound without error
567 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
569 /** Binds a socket on an already open file descriptor
570 * @param sockfd A valid file descriptor of an open socket
571 * @param port The port number to bind to
572 * @param addr The address to bind to (IP only)
573 * @return True if the port was bound successfully
575 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
577 /** Adds a server name to the list of servers we've seen
578 * @param The servername to add
580 void AddServerName(const std::string &servername);
582 /** Finds a cached char* pointer of a server name,
583 * This is used to optimize userrec by storing only the pointer to the name
584 * @param The servername to find
585 * @return A pointer to this name, gauranteed to never become invalid
587 const char* FindServerNamePtr(const std::string &servername);
589 /** Returns true if we've seen the given server name before
590 * @param The servername to find
591 * @return True if we've seen this server name before
593 bool FindServerName(const std::string &servername);
595 /** Gets the GECOS (description) field of the given server.
596 * If the servername is not that of the local server, the name
597 * is passed to handling modules which will attempt to determine
598 * the GECOS that bleongs to the given servername.
599 * @param servername The servername to find the description of
600 * @return The description of this server, or of the local server
602 std::string GetServerDescription(const char* servername);
604 /** Write text to all opers connected to this server
605 * @param text The text format string
606 * @param ... Format args
608 void WriteOpers(const char* text, ...);
610 /** Write text to all opers connected to this server
611 * @param text The text to send
613 void WriteOpers(const std::string &text);
615 /** Find a nickname in the nick hash
616 * @param nick The nickname to find
617 * @return A pointer to the user, or NULL if the user does not exist
619 userrec* FindNick(const std::string &nick);
621 /** Find a nickname in the nick hash
622 * @param nick The nickname to find
623 * @return A pointer to the user, or NULL if the user does not exist
625 userrec* FindNick(const char* nick);
627 /** Find a channel in the channels hash
628 * @param chan The channel to find
629 * @return A pointer to the channel, or NULL if the channel does not exist
631 chanrec* FindChan(const std::string &chan);
633 /** Find a channel in the channels hash
634 * @param chan The channel to find
635 * @return A pointer to the channel, or NULL if the channel does not exist
637 chanrec* FindChan(const char* chan);
639 /** Called by the constructor to load all modules from the config file.
641 void LoadAllModules();
643 /** Check for a 'die' tag in the config file, and abort if found
644 * @return Depending on the configuration, this function may never return
648 /** Check we aren't running as root, and exit if we are
649 * @return Depending on the configuration, this function may never return
653 /** Determine the right path for, and open, the logfile
654 * @param argv The argv passed to main() initially, used to calculate program path
655 * @param argc The argc passed to main() initially, used to calculate program path
657 void OpenLog(char** argv, int argc);
659 /** Close the currently open log file
663 /** Send a server notice to all local users
664 * @param text The text format string to send
665 * @param ... The format arguments
667 void ServerNoticeAll(char* text, ...);
669 /** Send a server message (PRIVMSG) to all local users
670 * @param text The text format string to send
671 * @param ... The format arguments
673 void ServerPrivmsgAll(char* text, ...);
675 /** Send text to all users with a specific set of modes
676 * @param modes The modes to check against, without a +, e.g. 'og'
677 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
678 * mode characters in the first parameter causes receipt of the message, and
679 * if you specify WM_OR, all the modes must be present.
680 * @param text The text format string to send
681 * @param ... The format arguments
683 void WriteMode(const char* modes, int flags, const char* text, ...);
685 /** Return true if a channel name is valid
686 * @param chname A channel name to verify
687 * @return True if the name is valid
689 bool IsChannel(const char *chname);
691 /** Rehash the local server
692 * @param status This value is unused, and required for signal handler functions
694 static void Rehash(int status);
696 /** Causes the server to exit after unloading modules and
697 * closing all open file descriptors.
699 * @param The exit code to give to the operating system
700 * (See the ExitStatus enum for valid values)
702 static void Exit(int status);
704 /** Causes the server to exit immediately with exit code 0.
705 * The status code is required for signal handlers, and ignored.
707 static void QuickExit(int status);
709 /** Return a count of users, unknown and known connections
710 * @return The number of users
714 /** Return a count of fully registered connections only
715 * @return The number of registered users
717 int RegisteredUserCount();
719 /** Return a count of invisible (umode +i) users only
720 * @return The number of invisible users
722 int InvisibleUserCount();
724 /** Return a count of opered (umode +o) users only
725 * @return The number of opers
729 /** Return a count of unregistered (before NICK/USER) users only
730 * @return The number of unregistered (unknown) connections
732 int UnregisteredUserCount();
734 /** Return a count of channels on the network
735 * @return The number of channels
739 /** Return a count of local users on this server only
740 * @return The number of local users
742 long LocalUserCount();
744 /** Send an error notice to all local users, opered and unopered
745 * @param s The error string to send
747 void SendError(const std::string &s);
749 /** For use with Module::Prioritize().
750 * When the return value of this function is returned from
751 * Module::Prioritize(), this specifies that the module wishes
752 * to be ordered exactly BEFORE 'modulename'. For more information
753 * please see Module::Prioritize().
754 * @param modulename The module your module wants to be before in the call list
755 * @returns a priority ID which the core uses to relocate the module in the list
757 long PriorityBefore(const std::string &modulename);
759 /** For use with Module::Prioritize().
760 * When the return value of this function is returned from
761 * Module::Prioritize(), this specifies that the module wishes
762 * to be ordered exactly AFTER 'modulename'. For more information please
763 * see Module::Prioritize().
764 * @param modulename The module your module wants to be after in the call list
765 * @returns a priority ID which the core uses to relocate the module in the list
767 long PriorityAfter(const std::string &modulename);
769 /** Publish a 'feature'.
770 * There are two ways for a module to find another module it depends on.
771 * Either by name, using InspIRCd::FindModule, or by feature, using this
772 * function. A feature is an arbitary string which identifies something this
773 * module can do. For example, if your module provides SSL support, but other
774 * modules provide SSL support too, all the modules supporting SSL should
775 * publish an identical 'SSL' feature. This way, any module requiring use
776 * of SSL functions can just look up the 'SSL' feature using FindFeature,
777 * then use the module pointer they are given.
778 * @param FeatureName The case sensitive feature name to make available
779 * @param Mod a pointer to your module class
780 * @returns True on success, false if the feature is already published by
783 bool PublishFeature(const std::string &FeatureName, Module* Mod);
785 /** Publish a module to an 'interface'.
786 * Modules which implement the same interface (the same way of communicating
787 * with other modules) can publish themselves to an interface, using this
788 * method. When they do so, they become part of a list of related or
789 * compatible modules, and a third module may then query for that list
790 * and know that all modules within that list offer the same API.
791 * A prime example of this is the hashing modules, which all accept the
792 * same types of Request class. Consider this to be similar to PublishFeature,
793 * except for that multiple modules may publish the same 'feature'.
794 * @param InterfaceName The case sensitive interface name to make available
795 * @param Mod a pointer to your module class
796 * @returns True on success, false on failure (there are currently no failure
799 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
801 /** Return a pair saying how many other modules are currently using the
802 * interfaces provided by module m.
803 * @param m The module to count usage for
804 * @return A pair, where the first value is the number of uses of the interface,
805 * and the second value is the interface name being used.
807 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
809 /** Mark your module as using an interface.
810 * If you mark your module as using an interface, then that interface
811 * module may not unload until your module has unloaded first.
812 * This can be used to prevent crashes by ensuring code you depend on
813 * is always in memory while your module is active.
814 * @param InterfaceName The interface to use
816 void UseInterface(const std::string &InterfaceName);
818 /** Mark your module as finished with an interface.
819 * If you used UseInterface() above, you should use this method when
820 * your module is finished with the interface (usually in its destructor)
821 * to allow the modules which implement the given interface to be unloaded.
822 * @param InterfaceName The interface you are finished with using.
824 void DoneWithInterface(const std::string &InterfaceName);
826 /** Unpublish a 'feature'.
827 * When your module exits, it must call this method for every feature it
828 * is providing so that the feature table is cleaned up.
829 * @param FeatureName the feature to remove
831 bool UnpublishFeature(const std::string &FeatureName);
833 /** Unpublish your module from an interface
834 * When your module exits, it must call this method for every interface
835 * it is part of so that the interfaces table is cleaned up. Only when
836 * the last item is deleted from an interface does the interface get
838 * @param InterfaceName the interface to be removed from
839 * @param Mod The module to remove from the interface list
841 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
843 /** Find a 'feature'.
844 * There are two ways for a module to find another module it depends on.
845 * Either by name, using InspIRCd::FindModule, or by feature, using the
846 * InspIRCd::PublishFeature method. A feature is an arbitary string which
847 * identifies something this module can do. For example, if your module
848 * provides SSL support, but other modules provide SSL support too, all
849 * the modules supporting SSL should publish an identical 'SSL' feature.
850 * To find a module capable of providing the feature you want, simply
851 * call this method with the feature name you are looking for.
852 * @param FeatureName The feature name you wish to obtain the module for
853 * @returns A pointer to a valid module class on success, NULL on failure.
855 Module* FindFeature(const std::string &FeatureName);
857 /** Find an 'interface'.
858 * An interface is a list of modules which all implement the same API.
859 * @param InterfaceName The Interface you wish to obtain the module
861 * @return A pointer to a deque of Module*, or NULL if the interface
864 modulelist* FindInterface(const std::string &InterfaceName);
866 /** Given a pointer to a Module, return its filename
867 * @param m The module pointer to identify
868 * @return The module name or an empty string
870 const std::string& GetModuleName(Module* m);
872 /** Return true if a nickname is valid
873 * @param n A nickname to verify
874 * @return True if the nick is valid
876 caller1<bool, const char*> IsNick;
878 /** Return true if an ident is valid
879 * @param An ident to verify
880 * @return True if the ident is valid
882 caller1<bool, const char*> IsIdent;
884 /** Find a username by their file descriptor.
885 * It is preferred to use this over directly accessing the fd_ref_table array.
886 * @param socket The file descriptor of a user
887 * @return A pointer to the user if the user exists locally on this descriptor
889 userrec* FindDescriptor(int socket);
891 /** Add a new mode to this server's mode parser
892 * @param mh The modehandler to add
893 * @param modechar The mode character this modehandler handles
894 * @return True if the mode handler was added
896 bool AddMode(ModeHandler* mh, const unsigned char modechar);
898 /** Add a new mode watcher to this server's mode parser
899 * @param mw The modewatcher to add
900 * @return True if the modewatcher was added
902 bool AddModeWatcher(ModeWatcher* mw);
904 /** Delete a mode watcher from this server's mode parser
905 * @param mw The modewatcher to delete
906 * @return True if the modewatcher was deleted
908 bool DelModeWatcher(ModeWatcher* mw);
910 /** Add a dns Resolver class to this server's active set
911 * @param r The resolver to add
912 * @param cached If this value is true, then the cache will
913 * be searched for the DNS result, immediately. If the value is
914 * false, then a request will be sent to the nameserver, and the
915 * result will not be immediately available. You should usually
916 * use the boolean value which you passed to the Resolver
917 * constructor, which Resolver will set appropriately depending
918 * on if cached results are available and haven't expired. It is
919 * however safe to force this value to false, forcing a remote DNS
920 * lookup, but not an update of the cache.
921 * @return True if the operation completed successfully. Note that
922 * if this method returns true, you should not attempt to access
923 * the resolver class you pass it after this call, as depending upon
924 * the request given, the object may be deleted!
926 bool AddResolver(Resolver* r, bool cached);
928 /** Add a command to this server's command parser
929 * @param f A command_t command handler object to add
930 * @throw ModuleException Will throw ModuleExcption if the command already exists
932 void AddCommand(command_t *f);
934 /** Send a modechange.
935 * The parameters provided are identical to that sent to the
936 * handler for class cmd_mode.
937 * @param parameters The mode parameters
938 * @param pcnt The number of items you have given in the first parameter
939 * @param user The user to send error messages to
941 void SendMode(const char **parameters, int pcnt, userrec *user);
943 /** Match two strings using pattern matching.
944 * This operates identically to the global function match(),
945 * except for that it takes std::string arguments rather than
947 * @param sliteral The literal string to match against
948 * @param spattern The pattern to match against. CIDR and globs are supported.
950 bool MatchText(const std::string &sliteral, const std::string &spattern);
952 /** Call the handler for a given command.
953 * @param commandname The command whos handler you wish to call
954 * @param parameters The mode parameters
955 * @param pcnt The number of items you have given in the first parameter
956 * @param user The user to execute the command as
957 * @return True if the command handler was called successfully
959 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
961 /** Return true if the command is a module-implemented command and the given parameters are valid for it
962 * @param parameters The mode parameters
963 * @param pcnt The number of items you have given in the first parameter
964 * @param user The user to test-execute the command as
965 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
967 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
969 /** Add a gline and apply it
970 * @param duration How long the line should last
971 * @param source Who set the line
972 * @param reason The reason for the line
973 * @param hostmask The hostmask to set the line against
975 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
977 /** Add a qline and apply it
978 * @param duration How long the line should last
979 * @param source Who set the line
980 * @param reason The reason for the line
981 * @param nickname The nickmask to set the line against
983 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
985 /** Add a zline and apply it
986 * @param duration How long the line should last
987 * @param source Who set the line
988 * @param reason The reason for the line
989 * @param ipaddr The ip-mask to set the line against
991 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
993 /** Add a kline and apply it
994 * @param duration How long the line should last
995 * @param source Who set the line
996 * @param reason The reason for the line
997 * @param hostmask The hostmask to set the line against
999 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1002 * @param duration How long the line should last
1003 * @param source Who set the line
1004 * @param reason The reason for the line
1005 * @param hostmask The hostmask to set the line against
1007 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1010 * @param hostmask The gline to delete
1011 * @return True if the item was removed
1013 bool DelGLine(const std::string &hostmask);
1016 * @param nickname The qline to delete
1017 * @return True if the item was removed
1019 bool DelQLine(const std::string &nickname);
1022 * @param ipaddr The zline to delete
1023 * @return True if the item was removed
1025 bool DelZLine(const std::string &ipaddr);
1028 * @param hostmask The kline to delete
1029 * @return True if the item was removed
1031 bool DelKLine(const std::string &hostmask);
1034 * @param hostmask The kline to delete
1035 * @return True if the item was removed
1037 bool DelELine(const std::string &hostmask);
1039 /** Return true if the given parameter is a valid nick!user\@host mask
1040 * @param mask A nick!user\@host masak to match against
1041 * @return True i the mask is valid
1043 bool IsValidMask(const std::string &mask);
1045 /** Rehash the local server
1047 void RehashServer();
1049 /** Return the channel whos index number matches that provided
1050 * @param The index number of the channel to fetch
1051 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1053 chanrec* GetChannelIndex(long index);
1055 /** Dump text to a user target, splitting it appropriately to fit
1056 * @param User the user to dump the text to
1057 * @param LinePrefix text to prefix each complete line with
1058 * @param TextStream the text to send to the user
1060 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1062 /** Check if the given nickmask matches too many users, send errors to the given user
1063 * @param nick A nickmask to match against
1064 * @param user A user to send error text to
1065 * @return True if the nick matches too many users
1067 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1069 /** Check if the given IP mask matches too many users, send errors to the given user
1070 * @param ip An ipmask to match against
1071 * @param user A user to send error text to
1072 * @return True if the ip matches too many users
1074 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1076 /** Check if the given hostmask matches too many users, send errors to the given user
1077 * @param mask A hostmask to match against
1078 * @param user A user to send error text to
1079 * @return True if the host matches too many users
1081 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1083 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1084 * @param str A string containing a time in the form 1y2w3d4h6m5s
1085 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1086 * @return The total number of seconds
1088 long Duration(const std::string &str);
1090 /** Attempt to compare an oper password to a string from the config file.
1091 * This will be passed to handling modules which will compare the data
1092 * against possible hashed equivalents in the input string.
1093 * @param data The data from the config file
1094 * @param input The data input by the oper
1095 * @param tagnum the tag number of the oper's tag in the config file
1096 * @return 0 if the strings match, 1 or -1 if they do not
1098 int OperPassCompare(const char* data,const char* input, int tagnum);
1100 /** Check if a given server is a uline.
1101 * An empty string returns true, this is by design.
1102 * @param server The server to check for uline status
1103 * @return True if the server is a uline OR the string is empty
1105 bool ULine(const char* server);
1107 /** Returns true if the uline is 'silent' (doesnt generate
1108 * remote connect notices etc).
1110 bool SilentULine(const char* server);
1112 /** Returns the subversion revision ID of this ircd
1113 * @return The revision ID or an empty string
1115 std::string GetRevision();
1117 /** Returns the full version string of this ircd
1118 * @return The version string
1120 std::string GetVersionString();
1122 /** Attempt to write the process id to a given file
1123 * @param filename The PID file to attempt to write to
1124 * @return This function may bail if the file cannot be written
1126 void WritePID(const std::string &filename);
1128 /** Returns text describing the last module error
1129 * @return The last error message to occur
1131 char* ModuleError();
1133 /** Load a given module file
1134 * @param filename The file to load
1135 * @return True if the module was found and loaded
1137 bool LoadModule(const char* filename);
1139 /** Unload a given module file
1140 * @param filename The file to unload
1141 * @return True if the module was unloaded
1143 bool UnloadModule(const char* filename);
1145 /** This constructor initialises all the subsystems and reads the config file.
1146 * @param argc The argument count passed to main()
1147 * @param argv The argument list passed to main()
1148 * @throw <anything> If anything is thrown from here and makes it to
1149 * you, you should probably just give up and go home. Yes, really.
1150 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1152 InspIRCd(int argc, char** argv);
1154 /** Do one iteration of the mainloop
1155 * @param process_module_sockets True if module sockets are to be processed
1156 * this time around the event loop. The is the default.
1158 void DoOneIteration(bool process_module_sockets = true);
1160 /** Output a log message to the ircd.log file
1161 * The text will only be output if the current loglevel
1162 * is less than or equal to the level you provide
1163 * @param level A log level from the DebugLevel enum
1164 * @param text Format string of to write to the log
1165 * @param ... Format arguments of text to write to the log
1167 void Log(int level, const char* text, ...);
1169 /** Output a log message to the ircd.log file
1170 * The text will only be output if the current loglevel
1171 * is less than or equal to the level you provide
1172 * @param level A log level from the DebugLevel enum
1173 * @param text Text to write to the log
1175 void Log(int level, const std::string &text);
1177 /** Send a line of WHOIS data to a user.
1178 * @param user user to send the line to
1179 * @param dest user being WHOISed
1180 * @param numeric Numeric to send
1181 * @param text Text of the numeric
1183 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1185 /** Send a line of WHOIS data to a user.
1186 * @param user user to send the line to
1187 * @param dest user being WHOISed
1188 * @param numeric Numeric to send
1189 * @param format Format string for the numeric
1190 * @param ... Parameters for the format string
1192 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1194 /** Quit a user for excess flood, and if they are not
1195 * fully registered yet, temporarily zline their IP.
1196 * @param current user to quit
1198 void FloodQuitUser(userrec* current);
1200 /** Restart the server.
1201 * This function will not return. If an error occurs,
1202 * it will throw an instance of CoreException.
1203 * @param reason The restart reason to show to all clients
1204 * @throw CoreException An instance of CoreException indicating the error from execv().
1206 void Restart(const std::string &reason);
1208 /** Prepare the ircd for restart or shutdown.
1209 * This function unloads all modules which can be unloaded,
1210 * closes all open sockets, and closes the logfile.
1214 /** This copies the user and channel hash_maps into new hash maps.
1215 * This frees memory used by the hash_map allocator (which it neglects
1216 * to free, most of the time, using tons of ram)
1218 void RehashUsersAndChans();
1220 /** Resets the cached max bans value on all channels.
1223 void ResetMaxBans();
1225 /** Return a time_t as a human-readable string.
1227 std::string TimeString(time_t curtime);
1229 /** Begin execution of the server.
1230 * NOTE: this function NEVER returns. Internally,
1231 * after performing some initialisation routines,
1232 * it will repeatedly call DoOneIteration in a loop.
1233 * @return The return value for this function is undefined.
1237 /** Force all InspSockets to be removed which are due to
1240 void InspSocketCull();