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)
69 if (in == 0) return "0";
74 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
81 std::reverse(res,out);
85 inline std::string ConvToStr(const int in)
87 return ConvNumeric(in);
90 inline std::string ConvToStr(const long in)
92 return ConvNumeric(in);
95 inline std::string ConvToStr(const unsigned long in)
97 return ConvNumeric(in);
100 inline std::string ConvToStr(const char* in)
105 inline std::string ConvToStr(const bool in)
107 return (in ? "1" : "0");
110 inline std::string ConvToStr(char in)
112 return std::string(in,1);
115 template <class T> inline std::string ConvToStr(const T &in)
117 std::stringstream tmp;
118 if (!(tmp << in)) return std::string();
122 template<typename T> inline long ConvToInt(const T &in)
124 std::stringstream tmp;
125 if (!(tmp << in)) return 0;
126 return atoi(tmp.str().c_str());
129 /** Template function to convert integer to char, storing result in *res and
130 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
132 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
134 if (base < 2 || base > 16) { *res = 0; return res; }
138 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
142 if ( in < 0 && base == 10) *out++ = '-';
143 std::reverse( res, out );
148 /** This class contains various STATS counters
149 * It is used by the InspIRCd class, which internally
150 * has an instance of it.
152 class serverstats : public classbase
155 /** Number of accepted connections
157 unsigned long statsAccept;
158 /** Number of failed accepts
160 unsigned long statsRefused;
161 /** Number of unknown commands seen
163 unsigned long statsUnknown;
164 /** Number of nickname collisions handled
166 unsigned long statsCollisions;
167 /** Number of DNS queries sent out
169 unsigned long statsDns;
170 /** Number of good DNS replies received
171 * NOTE: This may not tally to the number sent out,
172 * due to timeouts and other latency issues.
174 unsigned long statsDnsGood;
175 /** Number of bad (negative) DNS replies received
176 * NOTE: This may not tally to the number sent out,
177 * due to timeouts and other latency issues.
179 unsigned long statsDnsBad;
180 /** Number of inbound connections seen
182 unsigned long statsConnects;
183 /** Total bytes of data transmitted
186 /** Total bytes of data received
189 /** Number of bound listening ports
191 unsigned long BoundPortCount;
193 /** Cpu usage at last sample
197 /** Time last sample was read
201 /** The constructor initializes all the counts to zero
204 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
205 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0),
213 /** This class implements a nonblocking log-writer.
214 * Most people writing an ircd give little thought to their disk
215 * i/o. On a congested system, disk writes can block for long
216 * periods of time (e.g. if the system is busy and/or swapping
217 * a lot). If we just use a blocking fprintf() call, this could
218 * block for undesirable amounts of time (half of a second through
219 * to whole seconds). We DO NOT want this, so we make our logfile
220 * nonblocking and hook it into the SocketEngine.
221 * NB: If the operating system does not support nonblocking file
222 * I/O (linux seems to, as does freebsd) this will default to
223 * blocking behaviour.
225 class FileLogger : public EventHandler
228 /** The creator/owner of this object
230 InspIRCd* ServerInstance;
231 /** The log file (fd is inside this somewhere,
232 * we get it out with fileno())
235 /** Buffer of pending log lines to be written
238 /** Number of write operations that have occured
242 /** The constructor takes an already opened logfile.
244 FileLogger(InspIRCd* Instance, FILE* logfile);
245 /** This returns false, logfiles are writeable.
247 virtual bool Readable();
248 /** Handle pending write events.
249 * This will flush any waiting data to disk.
250 * If any data remains after the fprintf call,
251 * another write event is scheduled to write
252 * the rest of the data when possible.
254 virtual void HandleEvent(EventType et, int errornum = 0);
255 /** Write one or more preformatted log lines.
256 * If the data cannot be written immediately,
257 * this class will insert itself into the
258 * SocketEngine, and register a write event,
259 * and when the write event occurs it will
260 * attempt again to write the data.
262 void WriteLogLine(const std::string &line);
263 /** Close the log file and cancel any events.
265 virtual void Close();
266 /** Close the log file and cancel any events.
267 * (indirectly call Close()
269 virtual ~FileLogger();
272 /** A list of failed port bindings, used for informational purposes on startup */
273 typedef std::vector<std::pair<std::string, long> > FailedPortList;
275 /** A list of ip addresses cross referenced against clone counts */
276 typedef std::map<irc::string, unsigned int> clonemap;
280 /** The main class of the irc server.
281 * This class contains instances of all the other classes
282 * in this software, with the exception of the base class,
283 * classbase. Amongst other things, it contains a ModeParser,
284 * a DNS object, a CommandParser object, and a list of active
285 * Module objects, and facilities for Module objects to
286 * interact with the core system it implements. You should
287 * NEVER attempt to instantiate a class of type InspIRCd
288 * yourself. If you do, this is equivalent to spawning a second
289 * IRC server, and could have catastrophic consequences for the
290 * program in terms of ram usage (basically, you could create
291 * an obese forkbomb built from recursively spawning irc servers!)
293 class InspIRCd : public classbase
296 /** Holds a string describing the last module error to occur
300 /** Remove a ModuleFactory pointer
301 * @param j Index number of the ModuleFactory to remove
303 void EraseFactory(int j);
305 /** Remove a Module pointer
306 * @param j Index number of the Module to remove
308 void EraseModule(int j);
310 /** Build the ISUPPORT string by triggering all modules On005Numeric events
312 void BuildISupport();
314 /** Move a given module to a specific slot in the list
315 * @param modulename The module name to relocate
316 * @param slot The slot to move the module into
318 void MoveTo(std::string modulename,int slot);
320 /** Display the startup banner
324 /** Set up the signal handlers
328 /** Daemonize the ircd and close standard input/output streams
329 * @return True if the program daemonized succesfully
333 /** Moves the given module to the last slot in the list
334 * @param modulename The module name to relocate
336 void MoveToLast(std::string modulename);
338 /** Moves the given module to the first slot in the list
339 * @param modulename The module name to relocate
341 void MoveToFirst(std::string modulename);
343 /** Moves one module to be placed after another in the list
344 * @param modulename The module name to relocate
345 * @param after The module name to place the module after
347 void MoveAfter(std::string modulename, std::string after);
349 /** Moves one module to be placed before another in the list
350 * @param modulename The module name to relocate
351 * @param after The module name to place the module before
353 void MoveBefore(std::string modulename, std::string before);
355 /** Iterate the list of InspSocket objects, removing ones which have timed out
356 * @param TIME the current time
358 void DoSocketTimeouts(time_t TIME);
360 /** Perform background user events such as PING checks
361 * @param TIME the current time
363 void DoBackgroundUserStuff(time_t TIME);
365 /** Returns true when all modules have done pre-registration checks on a user
366 * @param user The user to verify
367 * @return True if all modules have finished checking this user
369 bool AllModulesReportReady(userrec* user);
371 /** Total number of modules loaded into the ircd, minus one
375 /** Logfile pathname specified on the commandline, or empty string
377 char LogFileName[MAXBUF];
379 /** The feature names published by various modules
381 featurelist Features;
383 /** The interface names published by various modules
385 interfacelist Interfaces;
387 /** The current time, updated in the mainloop
391 /** The time that was recorded last time around the mainloop
395 /** A 64k buffer used to read client lines into
397 char ReadBuffer[65535];
399 /** Number of seconds in a minute
401 const long duration_m;
403 /** Number of seconds in an hour
405 const long duration_h;
407 /** Number of seconds in a day
409 const long duration_d;
411 /** Number of seconds in a week
413 const long duration_w;
415 /** Number of seconds in a year
417 const long duration_y;
419 /** Used when connecting clients
421 insp_sockaddr client, server;
423 /** Used when connecting clients
427 /** Nonblocking file writer
431 /** Time offset in seconds
432 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
438 /** Number of unregistered users online right now.
439 * (Unregistered means before USER/NICK/dns)
441 int unregistered_count;
443 /** List of server names we've seen.
445 servernamelist servernames;
447 /** Time this ircd was booted
451 /** Mode handler, handles mode setting and removal
455 /** Command parser, handles client to server commands
457 CommandParser* Parser;
459 /** Socket engine, handles socket activity events
463 /** Stats class, holds miscellaneous stats counters
467 /** Server Config class, holds configuration file data
469 ServerConfig* Config;
471 /** Snomask manager - handles routing of snomask messages
476 /** Client list, a hash_map containing all clients, local and remote
478 user_hash* clientlist;
480 /** Channel list, a hash_map containing all channels
484 /** Local client list, a vector containing only local clients
486 std::vector<userrec*> local_users;
488 /** Oper list, a vector containing all local and remote opered users
490 std::vector<userrec*> all_opers;
492 clonemap local_clones;
494 clonemap global_clones;
496 /** DNS class, provides resolver facilities to the core and modules
500 /** Timer manager class, triggers InspTimer timer events
502 TimerManager* Timers;
504 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
506 XLineManager* XLines;
508 /** A list of Module* module classes
509 * Note that this list is always exactly 255 in size.
510 * The actual number of loaded modules is available from GetModuleCount()
514 /** A list of ModuleFactory* module factories
515 * Note that this list is always exactly 255 in size.
516 * The actual number of loaded modules is available from GetModuleCount()
520 /** The time we next call our ping timeout and reg timeout checks
524 /** Get the current time
525 * Because this only calls time() once every time around the mainloop,
526 * it is much faster than calling time() directly.
527 * @param delta True to use the delta as an offset, false otherwise
528 * @return The current time as an epoch value (time_t)
530 time_t Time(bool delta = false);
532 /** Set the time offset in seconds
533 * This offset is added to Time() to offset the system time by the specified
535 * @param delta The number of seconds to offset
536 * @return The old time delta
538 int SetTimeDelta(int delta);
540 void AddLocalClone(userrec* user);
542 void AddGlobalClone(userrec* user);
544 /** Number of users with a certain mode set on them
546 int ModeCount(const char mode);
548 /** Get the time offset in seconds
549 * @return The current time delta (in seconds)
553 /** Process a user whos socket has been flagged as active
554 * @param cu The user to process
555 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
557 void ProcessUser(userrec* cu);
559 /** Get the total number of currently loaded modules
560 * @return The number of loaded modules
562 int GetModuleCount();
564 /** Find a module by name, and return a Module* to it.
565 * This is preferred over iterating the module lists yourself.
566 * @param name The module name to look up
567 * @return A pointer to the module, or NULL if the module cannot be found
569 Module* FindModule(const std::string &name);
571 /** Bind all ports specified in the configuration file.
572 * @param bail True if the function should bail back to the shell on failure
573 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
574 * @return The number of ports actually bound without error
576 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
578 /** Returns true if this server has the given port bound to the given address
579 * @param port The port number
580 * @param addr The address
581 * @return True if we have a port listening on this address
583 bool HasPort(int port, char* addr);
585 /** Binds a socket on an already open file descriptor
586 * @param sockfd A valid file descriptor of an open socket
587 * @param client A sockaddr to use as temporary storage
588 * @param server A sockaddr to use as temporary storage
589 * @param port The port number to bind to
590 * @param addr The address to bind to (IP only)
591 * @return True if the port was bound successfully
593 bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
595 /** Adds a server name to the list of servers we've seen
596 * @param The servername to add
598 void AddServerName(const std::string &servername);
600 /** Finds a cached char* pointer of a server name,
601 * This is used to optimize userrec by storing only the pointer to the name
602 * @param The servername to find
603 * @return A pointer to this name, gauranteed to never become invalid
605 const char* FindServerNamePtr(const std::string &servername);
607 /** Returns true if we've seen the given server name before
608 * @param The servername to find
609 * @return True if we've seen this server name before
611 bool FindServerName(const std::string &servername);
613 /** Gets the GECOS (description) field of the given server.
614 * If the servername is not that of the local server, the name
615 * is passed to handling modules which will attempt to determine
616 * the GECOS that bleongs to the given servername.
617 * @param servername The servername to find the description of
618 * @return The description of this server, or of the local server
620 std::string GetServerDescription(const char* servername);
622 /** Write text to all opers connected to this server
623 * @param text The text format string
624 * @param ... Format args
626 void WriteOpers(const char* text, ...);
628 /** Write text to all opers connected to this server
629 * @param text The text to send
631 void WriteOpers(const std::string &text);
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 std::string &nick);
639 /** Find a nickname in the nick hash
640 * @param nick The nickname to find
641 * @return A pointer to the user, or NULL if the user does not exist
643 userrec* FindNick(const char* nick);
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 std::string &chan);
651 /** Find a channel in the channels hash
652 * @param chan The channel to find
653 * @return A pointer to the channel, or NULL if the channel does not exist
655 chanrec* FindChan(const char* chan);
657 /** Called by the constructor to load all modules from the config file.
659 void LoadAllModules();
661 /** Check for a 'die' tag in the config file, and abort if found
662 * @return Depending on the configuration, this function may never return
666 /** Check we aren't running as root, and exit if we are
667 * @return Depending on the configuration, this function may never return
671 /** Determine the right path for, and open, the logfile
672 * @param argv The argv passed to main() initially, used to calculate program path
673 * @param argc The argc passed to main() initially, used to calculate program path
675 void OpenLog(char** argv, int argc);
679 /** Convert a user to a pseudoclient, disconnecting the real user
680 * @param user The user to convert
681 * @param message The quit message to display when exiting the user
682 * @return True if the operation succeeded
684 bool UserToPseudo(userrec* user, const std::string &message);
686 /** Convert a pseudoclient to a real user, discarding the pseudoclient
687 * @param alive A live client
688 * @param zombie A pseudoclient
689 * @param message The message to display when quitting the pseudoclient
690 * @return True if the operation succeeded
692 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
694 /** Send a server notice to all local users
695 * @param text The text format string to send
696 * @param ... The format arguments
698 void ServerNoticeAll(char* text, ...);
700 /** Send a server message (PRIVMSG) to all local users
701 * @param text The text format string to send
702 * @param ... The format arguments
704 void ServerPrivmsgAll(char* text, ...);
706 /** Send text to all users with a specific set of modes
707 * @param modes The modes to check against, without a +, e.g. 'og'
708 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
709 * mode characters in the first parameter causes receipt of the message, and
710 * if you specify WM_OR, all the modes must be present.
711 * @param text The text format string to send
712 * @param ... The format arguments
714 void WriteMode(const char* modes, int flags, const char* text, ...);
716 /** Return true if a channel name is valid
717 * @param chname A channel name to verify
718 * @return True if the name is valid
720 bool IsChannel(const char *chname);
722 /** Rehash the local server
723 * @param status This value is unused, and required for signal handler functions
725 static void Rehash(int status);
727 /** Causes the server to exit immediately
728 * @param The exit code to give to the operating system
729 * (See the ExitStatus enum for valid values)
731 static void Exit(int status);
733 /** Return a count of users, unknown and known connections
734 * @return The number of users
738 /** Return a count of fully registered connections only
739 * @return The number of registered users
741 int RegisteredUserCount();
743 /** Return a count of invisible (umode +i) users only
744 * @return The number of invisible users
746 int InvisibleUserCount();
748 /** Return a count of opered (umode +o) users only
749 * @return The number of opers
753 /** Return a count of unregistered (before NICK/USER) users only
754 * @return The number of unregistered (unknown) connections
756 int UnregisteredUserCount();
758 /** Return a count of channels on the network
759 * @return The number of channels
763 /** Return a count of local users on this server only
764 * @return The number of local users
766 long LocalUserCount();
768 /** Send an error notice to all local users, opered and unopered
769 * @param s The error string to send
771 void SendError(const std::string &s);
773 /** For use with Module::Prioritize().
774 * When the return value of this function is returned from
775 * Module::Prioritize(), this specifies that the module wishes
776 * to be ordered exactly BEFORE 'modulename'. For more information
777 * please see Module::Prioritize().
778 * @param modulename The module your module wants to be before in the call list
779 * @returns a priority ID which the core uses to relocate the module in the list
781 long PriorityBefore(const std::string &modulename);
783 /** For use with Module::Prioritize().
784 * When the return value of this function is returned from
785 * Module::Prioritize(), this specifies that the module wishes
786 * to be ordered exactly AFTER 'modulename'. For more information please
787 * see Module::Prioritize().
788 * @param modulename The module your module wants to be after in the call list
789 * @returns a priority ID which the core uses to relocate the module in the list
791 long PriorityAfter(const std::string &modulename);
793 /** Publish a 'feature'.
794 * There are two ways for a module to find another module it depends on.
795 * Either by name, using InspIRCd::FindModule, or by feature, using this
796 * function. A feature is an arbitary string which identifies something this
797 * module can do. For example, if your module provides SSL support, but other
798 * modules provide SSL support too, all the modules supporting SSL should
799 * publish an identical 'SSL' feature. This way, any module requiring use
800 * of SSL functions can just look up the 'SSL' feature using FindFeature,
801 * then use the module pointer they are given.
802 * @param FeatureName The case sensitive feature name to make available
803 * @param Mod a pointer to your module class
804 * @returns True on success, false if the feature is already published by
807 bool PublishFeature(const std::string &FeatureName, Module* Mod);
809 /** Publish a module to an 'interface'.
810 * Modules which implement the same interface (the same way of communicating
811 * with other modules) can publish themselves to an interface, using this
812 * method. When they do so, they become part of a list of related or
813 * compatible modules, and a third module may then query for that list
814 * and know that all modules within that list offer the same API.
815 * A prime example of this is the hashing modules, which all accept the
816 * same types of Request class. Consider this to be similar to PublishFeature,
817 * except for that multiple modules may publish the same 'feature'.
818 * @param InterfaceName The case sensitive interface name to make available
819 * @param Mod a pointer to your module class
820 * @returns True on success, false on failure (there are currently no failure
823 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
825 /** Return a pair saying how many other modules are currently using the
826 * interfaces provided by module m.
827 * @param m The module to count usage for
828 * @return A pair, where the first value is the number of uses of the interface,
829 * and the second value is the interface name being used.
831 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
833 /** Mark your module as using an interface.
834 * If you mark your module as using an interface, then that interface
835 * module may not unload until your module has unloaded first.
836 * This can be used to prevent crashes by ensuring code you depend on
837 * is always in memory while your module is active.
838 * @param InterfaceName The interface to use
840 void UseInterface(const std::string &InterfaceName);
842 /** Mark your module as finished with an interface.
843 * If you used UseInterface() above, you should use this method when
844 * your module is finished with the interface (usually in its destructor)
845 * to allow the modules which implement the given interface to be unloaded.
846 * @param InterfaceName The interface you are finished with using.
848 void DoneWithInterface(const std::string &InterfaceName);
850 /** Unpublish a 'feature'.
851 * When your module exits, it must call this method for every feature it
852 * is providing so that the feature table is cleaned up.
853 * @param FeatureName the feature to remove
855 bool UnpublishFeature(const std::string &FeatureName);
857 /** Unpublish your module from an interface
858 * When your module exits, it must call this method for every interface
859 * it is part of so that the interfaces table is cleaned up. Only when
860 * the last item is deleted from an interface does the interface get
862 * @param InterfaceName the interface to be removed from
863 * @param Mod The module to remove from the interface list
865 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
867 /** Find a 'feature'.
868 * There are two ways for a module to find another module it depends on.
869 * Either by name, using InspIRCd::FindModule, or by feature, using the
870 * InspIRCd::PublishFeature method. A feature is an arbitary string which
871 * identifies something this module can do. For example, if your module
872 * provides SSL support, but other modules provide SSL support too, all
873 * the modules supporting SSL should publish an identical 'SSL' feature.
874 * To find a module capable of providing the feature you want, simply
875 * call this method with the feature name you are looking for.
876 * @param FeatureName The feature name you wish to obtain the module for
877 * @returns A pointer to a valid module class on success, NULL on failure.
879 Module* FindFeature(const std::string &FeatureName);
881 /** Find an 'interface'.
882 * An interface is a list of modules which all implement the same API.
883 * @param InterfaceName The Interface you wish to obtain the module
885 * @return A pointer to a deque of Module*, or NULL if the interface
888 modulelist* FindInterface(const std::string &InterfaceName);
890 /** Given a pointer to a Module, return its filename
891 * @param m The module pointer to identify
892 * @return The module name or an empty string
894 const std::string& GetModuleName(Module* m);
896 /** Return true if a nickname is valid
897 * @param n A nickname to verify
898 * @return True if the nick is valid
900 bool IsNick(const char* n);
902 /** Return true if an ident is valid
903 * @param An ident to verify
904 * @return True if the ident is valid
906 bool IsIdent(const char* n);
908 /** Find a username by their file descriptor.
909 * It is preferred to use this over directly accessing the fd_ref_table array.
910 * @param socket The file descriptor of a user
911 * @return A pointer to the user if the user exists locally on this descriptor
913 userrec* FindDescriptor(int socket);
915 /** Add a new mode to this server's mode parser
916 * @param mh The modehandler to add
917 * @param modechar The mode character this modehandler handles
918 * @return True if the mode handler was added
920 bool AddMode(ModeHandler* mh, const unsigned char modechar);
922 /** Add a new mode watcher to this server's mode parser
923 * @param mw The modewatcher to add
924 * @return True if the modewatcher was added
926 bool AddModeWatcher(ModeWatcher* mw);
928 /** Delete a mode watcher from this server's mode parser
929 * @param mw The modewatcher to delete
930 * @return True if the modewatcher was deleted
932 bool DelModeWatcher(ModeWatcher* mw);
934 /** Add a dns Resolver class to this server's active set
935 * @param r The resolver to add
936 * @param cached If this value is true, then the cache will
937 * be searched for the DNS result, immediately. If the value is
938 * false, then a request will be sent to the nameserver, and the
939 * result will not be immediately available. You should usually
940 * use the boolean value which you passed to the Resolver
941 * constructor, which Resolver will set appropriately depending
942 * on if cached results are available and haven't expired. It is
943 * however safe to force this value to false, forcing a remote DNS
944 * lookup, but not an update of the cache.
945 * @return True if the operation completed successfully. Note that
946 * if this method returns true, you should not attempt to access
947 * the resolver class you pass it after this call, as depending upon
948 * the request given, the object may be deleted!
950 bool AddResolver(Resolver* r, bool cached);
952 /** Add a command to this server's command parser
953 * @param f A command_t command handler object to add
954 * @throw ModuleException Will throw ModuleExcption if the command already exists
956 void AddCommand(command_t *f);
958 /** Send a modechange.
959 * The parameters provided are identical to that sent to the
960 * handler for class cmd_mode.
961 * @param parameters The mode parameters
962 * @param pcnt The number of items you have given in the first parameter
963 * @param user The user to send error messages to
965 void SendMode(const char **parameters, int pcnt, userrec *user);
967 /** Match two strings using pattern matching.
968 * This operates identically to the global function match(),
969 * except for that it takes std::string arguments rather than
971 * @param sliteral The literal string to match against
972 * @param spattern The pattern to match against. CIDR and globs are supported.
974 bool MatchText(const std::string &sliteral, const std::string &spattern);
976 /** Call the handler for a given command.
977 * @param commandname The command whos handler you wish to call
978 * @param parameters The mode parameters
979 * @param pcnt The number of items you have given in the first parameter
980 * @param user The user to execute the command as
981 * @return True if the command handler was called successfully
983 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
985 /** Return true if the command is a module-implemented command and the given parameters are valid for it
986 * @param parameters The mode parameters
987 * @param pcnt The number of items you have given in the first parameter
988 * @param user The user to test-execute the command as
989 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
991 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
993 /** Add a gline 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 AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1001 /** Add a qline and apply it
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 nickname The nickmask to set the line against
1007 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1009 /** Add a zline and apply it
1010 * @param duration How long the line should last
1011 * @param source Who set the line
1012 * @param reason The reason for the line
1013 * @param ipaddr The ip-mask to set the line against
1015 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1017 /** Add a kline and apply it
1018 * @param duration How long the line should last
1019 * @param source Who set the line
1020 * @param reason The reason for the line
1021 * @param hostmask The hostmask to set the line against
1023 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1026 * @param duration How long the line should last
1027 * @param source Who set the line
1028 * @param reason The reason for the line
1029 * @param hostmask The hostmask to set the line against
1031 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1034 * @param hostmask The gline to delete
1035 * @return True if the item was removed
1037 bool DelGLine(const std::string &hostmask);
1040 * @param nickname The qline to delete
1041 * @return True if the item was removed
1043 bool DelQLine(const std::string &nickname);
1046 * @param ipaddr The zline to delete
1047 * @return True if the item was removed
1049 bool DelZLine(const std::string &ipaddr);
1052 * @param hostmask The kline to delete
1053 * @return True if the item was removed
1055 bool DelKLine(const std::string &hostmask);
1058 * @param hostmask The kline to delete
1059 * @return True if the item was removed
1061 bool DelELine(const std::string &hostmask);
1063 /** Return true if the given parameter is a valid nick!user\@host mask
1064 * @param mask A nick!user\@host masak to match against
1065 * @return True i the mask is valid
1067 bool IsValidMask(const std::string &mask);
1069 /** Rehash the local server
1071 void RehashServer();
1073 /** Return the channel whos index number matches that provided
1074 * @param The index number of the channel to fetch
1075 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
1077 chanrec* GetChannelIndex(long index);
1079 /** Dump text to a user target, splitting it appropriately to fit
1080 * @param User the user to dump the text to
1081 * @param LinePrefix text to prefix each complete line with
1082 * @param TextStream the text to send to the user
1084 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1086 /** Check if the given nickmask matches too many users, send errors to the given user
1087 * @param nick A nickmask to match against
1088 * @param user A user to send error text to
1089 * @return True if the nick matches too many users
1091 bool NickMatchesEveryone(const std::string &nick, userrec* user);
1093 /** Check if the given IP mask matches too many users, send errors to the given user
1094 * @param ip An ipmask to match against
1095 * @param user A user to send error text to
1096 * @return True if the ip matches too many users
1098 bool IPMatchesEveryone(const std::string &ip, userrec* user);
1100 /** Check if the given hostmask matches too many users, send errors to the given user
1101 * @param mask A hostmask to match against
1102 * @param user A user to send error text to
1103 * @return True if the host matches too many users
1105 bool HostMatchesEveryone(const std::string &mask, userrec* user);
1107 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
1108 * @param str A string containing a time in the form 1y2w3d4h6m5s
1109 * (one year, two weeks, three days, four hours, six minutes and five seconds)
1110 * @return The total number of seconds
1112 long Duration(const char* str);
1114 /** Attempt to compare an oper password to a string from the config file.
1115 * This will be passed to handling modules which will compare the data
1116 * against possible hashed equivalents in the input string.
1117 * @param data The data from the config file
1118 * @param input The data input by the oper
1119 * @param tagnum the tag number of the oper's tag in the config file
1120 * @return 0 if the strings match, 1 or -1 if they do not
1122 int OperPassCompare(const char* data,const char* input, int tagnum);
1124 /** Check if a given server is a uline.
1125 * An empty string returns true, this is by design.
1126 * @param server The server to check for uline status
1127 * @return True if the server is a uline OR the string is empty
1129 bool ULine(const char* server);
1131 /** Returns the subversion revision ID of this ircd
1132 * @return The revision ID or an empty string
1134 std::string GetRevision();
1136 /** Returns the full version string of this ircd
1137 * @return The version string
1139 std::string GetVersionString();
1141 /** Attempt to write the process id to a given file
1142 * @param filename The PID file to attempt to write to
1143 * @return This function may bail if the file cannot be written
1145 void WritePID(const std::string &filename);
1147 /** Returns text describing the last module error
1148 * @return The last error message to occur
1150 char* ModuleError();
1152 /** Load a given module file
1153 * @param filename The file to load
1154 * @return True if the module was found and loaded
1156 bool LoadModule(const char* filename);
1158 /** Unload a given module file
1159 * @param filename The file to unload
1160 * @return True if the module was unloaded
1162 bool UnloadModule(const char* filename);
1164 /** This constructor initialises all the subsystems and reads the config file.
1165 * @param argc The argument count passed to main()
1166 * @param argv The argument list passed to main()
1167 * @throw <anything> If anything is thrown from here and makes it to
1168 * you, you should probably just give up and go home. Yes, really.
1169 * It's that bad. Higher level classes should catch any non-fatal exceptions.
1171 InspIRCd(int argc, char** argv);
1173 /** Do one iteration of the mainloop
1174 * @param process_module_sockets True if module sockets are to be processed
1175 * this time around the event loop. The is the default.
1177 void DoOneIteration(bool process_module_sockets = true);
1179 /** Output a log message to the ircd.log file
1180 * The text will only be output if the current loglevel
1181 * is less than or equal to the level you provide
1182 * @param level A log level from the DebugLevel enum
1183 * @param text Format string of to write to the log
1184 * @param ... Format arguments of text to write to the log
1186 void Log(int level, const char* text, ...);
1188 /** Output a log message to the ircd.log file
1189 * The text will only be output if the current loglevel
1190 * is less than or equal to the level you provide
1191 * @param level A log level from the DebugLevel enum
1192 * @param text Text to write to the log
1194 void Log(int level, const std::string &text);
1196 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1198 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
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 /** Begin execution of the server.
1226 * NOTE: this function NEVER returns. Internally,
1227 * after performing some initialisation routines,
1228 * it will repeatedly call DoOneIteration in a loop.
1229 * @return The return value for this function is undefined.