1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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 */
28 // Required system headers.
32 #include "inspircd_config.h"
40 #include "usermanager.h"
43 #include "command_parse.h"
45 #include "socketengine.h"
47 #include "cull_list.h"
48 #include "filelogger.h"
51 #include "configreader.h"
52 #include "inspstring.h"
55 * Used to define the maximum number of parameters a command may have.
57 #define MAXPARAMETERS 127
59 /** Returned by some functions to indicate failure.
63 /** Support for librodent -
64 * see http://www.chatspike.net/index.php?z=64
66 #define ETIREDHAMSTERS EAGAIN
68 /** Template function to convert any input type to std::string
70 template<typename T> inline std::string ConvNumeric(const T &in)
72 if (in == 0) return "0";
77 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
84 std::reverse(res,out);
88 /** Template function to convert any input type to std::string
90 inline std::string ConvToStr(const int in)
92 return ConvNumeric(in);
95 /** Template function to convert any input type to std::string
97 inline std::string ConvToStr(const long in)
99 return ConvNumeric(in);
102 /** Template function to convert any input type to std::string
104 inline std::string ConvToStr(const char* in)
109 /** Template function to convert any input type to std::string
111 inline std::string ConvToStr(const bool in)
113 return (in ? "1" : "0");
116 /** Template function to convert any input type to std::string
118 inline std::string ConvToStr(char in)
120 return std::string(in,1);
123 /** Template function to convert any input type to std::string
125 template <class T> inline std::string ConvToStr(const T &in)
127 std::stringstream tmp;
128 if (!(tmp << in)) return std::string();
132 /** Template function to convert any input type to any other type
133 * (usually an integer or numeric type)
135 template<typename T> inline long ConvToInt(const T &in)
137 std::stringstream tmp;
138 if (!(tmp << in)) return 0;
139 return atoi(tmp.str().c_str());
142 /** Template function to convert integer to char, storing result in *res and
143 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
144 * @param T input value
145 * @param V result value
146 * @param R base to convert to
148 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
150 if (base < 2 || base > 16) { *res = 0; return res; }
154 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
158 if ( in < 0 && base == 10) *out++ = '-';
159 std::reverse( res, out );
164 /** This class contains various STATS counters
165 * It is used by the InspIRCd class, which internally
166 * has an instance of it.
168 class serverstats : public classbase
171 /** Number of accepted connections
173 unsigned long statsAccept;
174 /** Number of failed accepts
176 unsigned long statsRefused;
177 /** Number of unknown commands seen
179 unsigned long statsUnknown;
180 /** Number of nickname collisions handled
182 unsigned long statsCollisions;
183 /** Number of DNS queries sent out
185 unsigned long statsDns;
186 /** Number of good DNS replies received
187 * NOTE: This may not tally to the number sent out,
188 * due to timeouts and other latency issues.
190 unsigned long statsDnsGood;
191 /** Number of bad (negative) DNS replies received
192 * NOTE: This may not tally to the number sent out,
193 * due to timeouts and other latency issues.
195 unsigned long statsDnsBad;
196 /** Number of inbound connections seen
198 unsigned long statsConnects;
199 /** Total bytes of data transmitted
202 /** Total bytes of data received
205 /** Cpu usage at last sample
208 /** Time last sample was read
211 /** The constructor initializes all the counts to zero
214 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
215 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
220 /** A list of failed port bindings, used for informational purposes on startup */
221 typedef std::vector<std::pair<std::string, long> > FailedPortList;
225 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
226 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
227 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
228 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
229 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
231 /* Forward declaration - required */
233 class BanCacheManager;
235 /** The main class of the irc server.
236 * This class contains instances of all the other classes
237 * in this software, with the exception of the base class,
238 * classbase. Amongst other things, it contains a ModeParser,
239 * a DNS object, a CommandParser object, and a list of active
240 * Module objects, and facilities for Module objects to
241 * interact with the core system it implements. You should
242 * NEVER attempt to instantiate a class of type InspIRCd
243 * yourself. If you do, this is equivalent to spawning a second
244 * IRC server, and could have catastrophic consequences for the
245 * program in terms of ram usage (basically, you could create
246 * an obese forkbomb built from recursively spawning irc servers!)
248 class CoreExport InspIRCd : public classbase
251 /** Holds the current UID. Used to generate the next one.
253 char current_uid[UUID_LENGTH];
255 /** Set up the signal handlers
259 /** Daemonize the ircd and close standard input/output streams
260 * @return True if the program daemonized succesfully
264 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
265 * @param TIME the current time
267 void DoSocketTimeouts(time_t TIME);
269 /** Sets up UID subsystem
271 void InitialiseUID();
273 /** Perform background user events such as PING checks
275 void DoBackgroundUserStuff();
277 /** Returns true when all modules have done pre-registration checks on a user
278 * @param user The user to verify
279 * @return True if all modules have finished checking this user
281 bool AllModulesReportReady(User* user);
283 /** Logfile pathname specified on the commandline, or empty string
285 char LogFileName[MAXBUF];
287 /** The current time, updated in the mainloop
291 /** The time that was recorded last time around the mainloop
295 /** A 64k buffer used to read client lines into
297 char ReadBuffer[65535];
299 /** Used when connecting clients
301 irc::sockets::insp_sockaddr client, server;
303 /** Used when connecting clients
307 /** Time offset in seconds
308 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
318 /** Global cull list, will be processed on next iteration
320 CullList GlobalCulls;
324 ProcessUserHandler HandleProcessUser;
325 IsNickHandler HandleIsNick;
326 IsIdentHandler HandleIsIdent;
327 FindDescriptorHandler HandleFindDescriptor;
328 FloodQuitUserHandler HandleFloodQuitUser;
330 /** BufferedSocket classes pending deletion after being closed.
331 * We don't delete these immediately as this may cause a segmentation fault.
333 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
335 /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
338 * SendMode expects a User* to send the numeric replies
339 * back to, so we create it a fake user that isnt in the user
340 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
341 * falls into the abyss :p
345 /** Returns the next available UID for this server.
347 std::string GetUID();
349 /** Find a user in the UUID hash
350 * @param nick The nickname to find
351 * @return A pointer to the user, or NULL if the user does not exist
353 User *FindUUID(const std::string &);
355 /** Find a user in the UUID hash
356 * @param nick The nickname to find
357 * @return A pointer to the user, or NULL if the user does not exist
359 User *FindUUID(const char *);
361 /** Build the ISUPPORT string by triggering all modules On005Numeric events
363 void BuildISupport();
365 /** List of server names we've seen.
367 servernamelist servernames;
369 /** Time this ircd was booted
373 /** Config file pathname specified on the commandline or via ./configure
375 char ConfigFileName[MAXBUF];
377 /** Mode handler, handles mode setting and removal
381 /** Command parser, handles client to server commands
383 CommandParser* Parser;
385 /** Socket engine, handles socket activity events
389 /** LogManager handles logging.
393 /** ModuleManager contains everything related to loading/unloading
396 ModuleManager* Modules;
398 /** BanCacheManager is used to speed up checking of restrictions on connection
401 BanCacheManager *BanCache;
403 /** Stats class, holds miscellaneous stats counters
407 /** Server Config class, holds configuration file data
409 ServerConfig* Config;
411 /** Snomask manager - handles routing of snomask messages
416 /** DNS class, provides resolver facilities to the core and modules
420 /** Timer manager class, triggers Timer timer events
422 TimerManager* Timers;
424 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
426 XLineManager* XLines;
428 /** User manager. Various methods and data associated with users.
432 /** Channel list, a hash_map containing all channels XXX move to channel manager class
436 /** Set to the current signal recieved
440 /** Get the current time
441 * Because this only calls time() once every time around the mainloop,
442 * it is much faster than calling time() directly.
443 * @param delta True to use the delta as an offset, false otherwise
444 * @return The current time as an epoch value (time_t)
446 time_t Time(bool delta = false);
448 /** Set the time offset in seconds
449 * This offset is added to Time() to offset the system time by the specified
451 * @param delta The number of seconds to offset
452 * @return The old time delta
454 int SetTimeDelta(int delta);
456 /** Get the time offset in seconds
457 * @return The current time delta (in seconds)
461 /** Process a user whos socket has been flagged as active
462 * @param cu The user to process
463 * @return There is no actual return value, however upon exit, the user 'cu' may have been
464 * marked for deletion in the global CullList.
466 caller1<void, User*> ProcessUser;
468 /** Bind all ports specified in the configuration file.
469 * @param bail True if the function should bail back to the shell on failure
470 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
471 * @return The number of ports actually bound without error
473 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
475 /** Binds a socket on an already open file descriptor
476 * @param sockfd A valid file descriptor of an open socket
477 * @param port The port number to bind to
478 * @param addr The address to bind to (IP only)
479 * @return True if the port was bound successfully
481 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
483 /** Adds a server name to the list of servers we've seen
484 * @param The servername to add
486 void AddServerName(const std::string &servername);
488 /** Finds a cached char* pointer of a server name,
489 * This is used to optimize User by storing only the pointer to the name
490 * @param The servername to find
491 * @return A pointer to this name, gauranteed to never become invalid
493 const char* FindServerNamePtr(const std::string &servername);
495 /** Returns true if we've seen the given server name before
496 * @param The servername to find
497 * @return True if we've seen this server name before
499 bool FindServerName(const std::string &servername);
501 /** Gets the GECOS (description) field of the given server.
502 * If the servername is not that of the local server, the name
503 * is passed to handling modules which will attempt to determine
504 * the GECOS that bleongs to the given servername.
505 * @param servername The servername to find the description of
506 * @return The description of this server, or of the local server
508 std::string GetServerDescription(const char* servername);
510 /** Find a user in the nick hash.
511 * If the user cant be found in the nick hash check the uuid hash
512 * @param nick The nickname to find
513 * @return A pointer to the user, or NULL if the user does not exist
515 User* FindNick(const std::string &nick);
517 /** Find a user in the nick hash.
518 * If the user cant be found in the nick hash check the uuid hash
519 * @param nick The nickname to find
520 * @return A pointer to the user, or NULL if the user does not exist
522 User* FindNick(const char* nick);
524 /** Find a user in the nick hash ONLY
526 User* FindNickOnly(const char* nick);
528 /** Find a user in the nick hash ONLY
530 User* FindNickOnly(const std::string &nick);
532 /** Find a channel in the channels hash
533 * @param chan The channel to find
534 * @return A pointer to the channel, or NULL if the channel does not exist
536 Channel* FindChan(const std::string &chan);
538 /** Find a channel in the channels hash
539 * @param chan The channel to find
540 * @return A pointer to the channel, or NULL if the channel does not exist
542 Channel* FindChan(const char* chan);
544 /** Check for a 'die' tag in the config file, and abort if found
545 * @return Depending on the configuration, this function may never return
549 /** Check we aren't running as root, and exit if we are
550 * @return Depending on the configuration, this function may never return
554 /** Determine the right path for, and open, the logfile
555 * @param argv The argv passed to main() initially, used to calculate program path
556 * @param argc The argc passed to main() initially, used to calculate program path
557 * @return True if the log could be opened, false if otherwise
559 bool OpenLog(char** argv, int argc);
561 /** Return true if a channel name is valid
562 * @param chname A channel name to verify
563 * @return True if the name is valid
565 bool IsChannel(const char *chname);
567 /** Return true if str looks like a server ID
568 * @param string to check against
570 bool IsSID(const std::string &str);
572 /** Rehash the local server
576 /** Handles incoming signals after being set
577 * @param signal the signal recieved
579 void SignalHandler(int signal);
581 /** Sets the signal recieved
582 * @param signal the signal recieved
584 static void SetSignal(int signal);
586 /** Causes the server to exit after unloading modules and
587 * closing all open file descriptors.
589 * @param The exit code to give to the operating system
590 * (See the ExitStatus enum for valid values)
592 void Exit(int status);
594 /** Causes the server to exit immediately with exit code 0.
595 * The status code is required for signal handlers, and ignored.
597 static void QuickExit(int status);
599 /** Return a count of channels on the network
600 * @return The number of channels
604 /** Send an error notice to all local users, opered and unopered
605 * @param s The error string to send
607 void SendError(const std::string &s);
609 /** Return true if a nickname is valid
610 * @param n A nickname to verify
611 * @return True if the nick is valid
613 caller1<bool, const char*> IsNick;
615 /** Return true if an ident is valid
616 * @param An ident to verify
617 * @return True if the ident is valid
619 caller1<bool, const char*> IsIdent;
621 /** Find a username by their file descriptor.
622 * It is preferred to use this over directly accessing the fd_ref_table array.
623 * @param socket The file descriptor of a user
624 * @return A pointer to the user if the user exists locally on this descriptor
626 caller1<User*, int> FindDescriptor;
628 /** Add a dns Resolver class to this server's active set
629 * @param r The resolver to add
630 * @param cached If this value is true, then the cache will
631 * be searched for the DNS result, immediately. If the value is
632 * false, then a request will be sent to the nameserver, and the
633 * result will not be immediately available. You should usually
634 * use the boolean value which you passed to the Resolver
635 * constructor, which Resolver will set appropriately depending
636 * on if cached results are available and haven't expired. It is
637 * however safe to force this value to false, forcing a remote DNS
638 * lookup, but not an update of the cache.
639 * @return True if the operation completed successfully. Note that
640 * if this method returns true, you should not attempt to access
641 * the resolver class you pass it after this call, as depending upon
642 * the request given, the object may be deleted!
644 bool AddResolver(Resolver* r, bool cached);
646 /** Add a command to this server's command parser
647 * @param f A Command command handler object to add
648 * @throw ModuleException Will throw ModuleExcption if the command already exists
650 void AddCommand(Command *f);
652 /** Send a modechange.
653 * The parameters provided are identical to that sent to the
654 * handler for class cmd_mode.
655 * @param parameters The mode parameters
656 * @param pcnt The number of items you have given in the first parameter
657 * @param user The user to send error messages to
659 void SendMode(const char **parameters, int pcnt, User *user);
661 /** Match two strings using pattern matching.
662 * This operates identically to the global function match(),
663 * except for that it takes std::string arguments rather than
665 * @param sliteral The literal string to match against
666 * @param spattern The pattern to match against. CIDR and globs are supported.
668 bool MatchText(const std::string &sliteral, const std::string &spattern);
670 /** Call the handler for a given command.
671 * @param commandname The command whos handler you wish to call
672 * @param parameters The mode parameters
673 * @param pcnt The number of items you have given in the first parameter
674 * @param user The user to execute the command as
675 * @return True if the command handler was called successfully
677 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user);
679 /** Return true if the command is a module-implemented command and the given parameters are valid for it
680 * @param parameters The mode parameters
681 * @param pcnt The number of items you have given in the first parameter
682 * @param user The user to test-execute the command as
683 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
685 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
687 /** Return true if the given parameter is a valid nick!user\@host mask
688 * @param mask A nick!user\@host masak to match against
689 * @return True i the mask is valid
691 bool IsValidMask(const std::string &mask);
693 /** Rehash the local server
697 /** Return the channel whos index number matches that provided
698 * @param The index number of the channel to fetch
699 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
701 Channel* GetChannelIndex(long index);
703 /** Dump text to a user target, splitting it appropriately to fit
704 * @param User the user to dump the text to
705 * @param LinePrefix text to prefix each complete line with
706 * @param TextStream the text to send to the user
708 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
710 /** Check if the given nickmask matches too many users, send errors to the given user
711 * @param nick A nickmask to match against
712 * @param user A user to send error text to
713 * @return True if the nick matches too many users
715 bool NickMatchesEveryone(const std::string &nick, User* user);
717 /** Check if the given IP mask matches too many users, send errors to the given user
718 * @param ip An ipmask to match against
719 * @param user A user to send error text to
720 * @return True if the ip matches too many users
722 bool IPMatchesEveryone(const std::string &ip, User* user);
724 /** Check if the given hostmask matches too many users, send errors to the given user
725 * @param mask A hostmask to match against
726 * @param user A user to send error text to
727 * @return True if the host matches too many users
729 bool HostMatchesEveryone(const std::string &mask, User* user);
731 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
732 * @param str A string containing a time in the form 1y2w3d4h6m5s
733 * (one year, two weeks, three days, four hours, six minutes and five seconds)
734 * @return The total number of seconds
736 long Duration(const std::string &str);
738 /** Attempt to compare a password to a string from the config file.
739 * This will be passed to handling modules which will compare the data
740 * against possible hashed equivalents in the input string.
741 * @param ex The object (user, server, whatever) causing the comparison.
742 * @param data The data from the config file
743 * @param input The data input by the oper
744 * @param hashtype The hash from the config file
745 * @return 0 if the strings match, 1 or -1 if they do not
747 int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
749 /** Check if a given server is a uline.
750 * An empty string returns true, this is by design.
751 * @param server The server to check for uline status
752 * @return True if the server is a uline OR the string is empty
754 bool ULine(const char* server);
756 /** Returns true if the uline is 'silent' (doesnt generate
757 * remote connect notices etc).
759 bool SilentULine(const char* server);
761 /** Returns the subversion revision ID of this ircd
762 * @return The revision ID or an empty string
764 std::string GetRevision();
766 /** Returns the full version string of this ircd
767 * @return The version string
769 std::string GetVersionString();
771 /** Attempt to write the process id to a given file
772 * @param filename The PID file to attempt to write to
773 * @return This function may bail if the file cannot be written
775 void WritePID(const std::string &filename);
777 /** This constructor initialises all the subsystems and reads the config file.
778 * @param argc The argument count passed to main()
779 * @param argv The argument list passed to main()
780 * @throw <anything> If anything is thrown from here and makes it to
781 * you, you should probably just give up and go home. Yes, really.
782 * It's that bad. Higher level classes should catch any non-fatal exceptions.
784 InspIRCd(int argc, char** argv);
786 /** Output a log message to the ircd.log file
787 * The text will only be output if the current loglevel
788 * is less than or equal to the level you provide
789 * @param level A log level from the DebugLevel enum
790 * @param text Format string of to write to the log
791 * @param ... Format arguments of text to write to the log
793 void Log(int level, const char* text, ...);
795 /** Output a log message to the ircd.log file
796 * The text will only be output if the current loglevel
797 * is less than or equal to the level you provide
798 * @param level A log level from the DebugLevel enum
799 * @param text Text to write to the log
801 void Log(int level, const std::string &text);
803 /** Send a line of WHOIS data to a user.
804 * @param user user to send the line to
805 * @param dest user being WHOISed
806 * @param numeric Numeric to send
807 * @param text Text of the numeric
809 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
811 /** Send a line of WHOIS data to a user.
812 * @param user user to send the line to
813 * @param dest user being WHOISed
814 * @param numeric Numeric to send
815 * @param format Format string for the numeric
816 * @param ... Parameters for the format string
818 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
820 /** Quit a user for excess flood, and if they are not
821 * fully registered yet, temporarily zline their IP.
822 * @param current user to quit
824 caller1<void, User*> FloodQuitUser;
826 /** Restart the server.
827 * This function will not return. If an error occurs,
828 * it will throw an instance of CoreException.
829 * @param reason The restart reason to show to all clients
830 * @throw CoreException An instance of CoreException indicating the error from execv().
832 void Restart(const std::string &reason);
834 /** Prepare the ircd for restart or shutdown.
835 * This function unloads all modules which can be unloaded,
836 * closes all open sockets, and closes the logfile.
840 /** This copies the user and channel hash_maps into new hash maps.
841 * This frees memory used by the hash_map allocator (which it neglects
842 * to free, most of the time, using tons of ram)
844 void RehashUsersAndChans();
846 /** Resets the cached max bans value on all channels.
851 /** Return a time_t as a human-readable string.
853 std::string TimeString(time_t curtime);
855 /** Begin execution of the server.
856 * NOTE: this function NEVER returns. Internally,
857 * it will repeatedly loop.
858 * @return The return value for this function is undefined.
862 /** Force all BufferedSockets to be removed which are due to
865 void BufferedSocketCull();
867 char* GetReadBuffer()
869 return this->ReadBuffer;