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.
35 #include "inspircd_config.h"
42 #include "usermanager.h"
45 #include "command_parse.h"
47 #include "socketengine.h"
49 #include "cull_list.h"
50 #include "filelogger.h"
52 //#include "inspsocket.h"
54 #include "configreader.h"
55 #include "inspstring.h"
58 * Used to define the maximum number of parameters a command may have.
60 #define MAXPARAMETERS 127
62 /** Returned by some functions to indicate failure.
66 /** Support for librodent -
67 * see http://www.chatspike.net/index.php?z=64
69 #define ETIREDHAMSTERS EAGAIN
71 /** Template function to convert any input type to std::string
73 template<typename T> inline std::string ConvNumeric(const T &in)
75 if (in == 0) return "0";
80 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
87 std::reverse(res,out);
91 /** Template function to convert any input type to std::string
93 inline std::string ConvToStr(const int in)
95 return ConvNumeric(in);
98 /** Template function to convert any input type to std::string
100 inline std::string ConvToStr(const long in)
102 return ConvNumeric(in);
105 /** Template function to convert any input type to std::string
107 inline std::string ConvToStr(const char* in)
112 /** Template function to convert any input type to std::string
114 inline std::string ConvToStr(const bool in)
116 return (in ? "1" : "0");
119 /** Template function to convert any input type to std::string
121 inline std::string ConvToStr(char in)
123 return std::string(in,1);
126 /** Template function to convert any input type to std::string
128 template <class T> inline std::string ConvToStr(const T &in)
130 std::stringstream tmp;
131 if (!(tmp << in)) return std::string();
135 /** Template function to convert any input type to any other type
136 * (usually an integer or numeric type)
138 template<typename T> inline long ConvToInt(const T &in)
140 std::stringstream tmp;
141 if (!(tmp << in)) return 0;
142 return atoi(tmp.str().c_str());
145 /** Template function to convert integer to char, storing result in *res and
146 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
147 * @param T input value
148 * @param V result value
149 * @param R base to convert to
151 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
153 if (base < 2 || base > 16) { *res = 0; return res; }
157 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
161 if ( in < 0 && base == 10) *out++ = '-';
162 std::reverse( res, out );
167 /** This class contains various STATS counters
168 * It is used by the InspIRCd class, which internally
169 * has an instance of it.
171 class serverstats : public classbase
174 /** Number of accepted connections
176 unsigned long statsAccept;
177 /** Number of failed accepts
179 unsigned long statsRefused;
180 /** Number of unknown commands seen
182 unsigned long statsUnknown;
183 /** Number of nickname collisions handled
185 unsigned long statsCollisions;
186 /** Number of DNS queries sent out
188 unsigned long statsDns;
189 /** Number of good DNS replies received
190 * NOTE: This may not tally to the number sent out,
191 * due to timeouts and other latency issues.
193 unsigned long statsDnsGood;
194 /** Number of bad (negative) DNS replies received
195 * NOTE: This may not tally to the number sent out,
196 * due to timeouts and other latency issues.
198 unsigned long statsDnsBad;
199 /** Number of inbound connections seen
201 unsigned long statsConnects;
202 /** Total bytes of data transmitted
205 /** Total bytes of data received
208 /** Cpu usage at last sample
211 /** Time last sample was read
214 /** The constructor initializes all the counts to zero
217 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
218 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
223 /** A list of failed port bindings, used for informational purposes on startup */
224 typedef std::vector<std::pair<std::string, long> > FailedPortList;
228 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
229 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
230 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
231 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
232 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
234 /* Forward declaration - required */
236 class BanCacheManager;
238 /** The main class of the irc server.
239 * This class contains instances of all the other classes
240 * in this software, with the exception of the base class,
241 * classbase. Amongst other things, it contains a ModeParser,
242 * a DNS object, a CommandParser object, and a list of active
243 * Module objects, and facilities for Module objects to
244 * interact with the core system it implements. You should
245 * NEVER attempt to instantiate a class of type InspIRCd
246 * yourself. If you do, this is equivalent to spawning a second
247 * IRC server, and could have catastrophic consequences for the
248 * program in terms of ram usage (basically, you could create
249 * an obese forkbomb built from recursively spawning irc servers!)
251 class CoreExport InspIRCd : public classbase
254 /** Holds the current UID. Used to generate the next one.
256 char current_uid[UUID_LENGTH];
258 /** Set up the signal handlers
262 /** Daemonize the ircd and close standard input/output streams
263 * @return True if the program daemonized succesfully
267 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
268 * @param TIME the current time
270 void DoSocketTimeouts(time_t TIME);
272 /** Sets up UID subsystem
274 void InitialiseUID();
276 /** Perform background user events such as PING checks
278 void DoBackgroundUserStuff();
280 /** Returns true when all modules have done pre-registration checks on a user
281 * @param user The user to verify
282 * @return True if all modules have finished checking this user
284 bool AllModulesReportReady(User* user);
286 /** Logfile pathname specified on the commandline, or empty string
288 char LogFileName[MAXBUF];
290 /** The current time, updated in the mainloop
294 /** The time that was recorded last time around the mainloop
298 /** A 64k buffer used to read client lines into
300 char ReadBuffer[65535];
302 /** Used when connecting clients
304 irc::sockets::insp_sockaddr client, server;
306 /** Used when connecting clients
310 /** Nonblocking file writer
314 /** Time offset in seconds
315 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
325 /** Global cull list, will be processed on next iteration
327 CullList GlobalCulls;
331 ProcessUserHandler HandleProcessUser;
332 IsNickHandler HandleIsNick;
333 IsIdentHandler HandleIsIdent;
334 FindDescriptorHandler HandleFindDescriptor;
335 FloodQuitUserHandler HandleFloodQuitUser;
337 /** BufferedSocket classes pending deletion after being closed.
338 * We don't delete these immediately as this may cause a segmentation fault.
340 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
342 /** 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
345 * SendMode expects a User* to send the numeric replies
346 * back to, so we create it a fake user that isnt in the user
347 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
348 * falls into the abyss :p
352 /** Returns the next available UID for this server.
354 std::string GetUID();
356 /** Find a user in the UUID hash
357 * @param nick The nickname to find
358 * @return A pointer to the user, or NULL if the user does not exist
360 User *FindUUID(const std::string &);
362 /** Find a user in the UUID hash
363 * @param nick The nickname to find
364 * @return A pointer to the user, or NULL if the user does not exist
366 User *FindUUID(const char *);
368 /** Build the ISUPPORT string by triggering all modules On005Numeric events
370 void BuildISupport();
372 /** List of server names we've seen.
374 servernamelist servernames;
376 /** Time this ircd was booted
380 /** Config file pathname specified on the commandline or via ./configure
382 char ConfigFileName[MAXBUF];
384 /** Mode handler, handles mode setting and removal
388 /** Command parser, handles client to server commands
390 CommandParser* Parser;
392 /** Socket engine, handles socket activity events
396 /** ModuleManager contains everything related to loading/unloading
399 ModuleManager* Modules;
401 /** BanCacheManager is used to speed up checking of restrictions on connection
404 BanCacheManager *BanCache;
406 /** Stats class, holds miscellaneous stats counters
410 /** Server Config class, holds configuration file data
412 ServerConfig* Config;
414 /** Snomask manager - handles routing of snomask messages
419 /** DNS class, provides resolver facilities to the core and modules
423 /** Timer manager class, triggers Timer timer events
425 TimerManager* Timers;
427 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
429 XLineManager* XLines;
431 /** User manager. Various methods and data associated with users.
435 /** Channel list, a hash_map containing all channels XXX move to channel manager class
439 /** Set to the current signal recieved
443 /** Get the current time
444 * Because this only calls time() once every time around the mainloop,
445 * it is much faster than calling time() directly.
446 * @param delta True to use the delta as an offset, false otherwise
447 * @return The current time as an epoch value (time_t)
449 time_t Time(bool delta = false);
451 /** Set the time offset in seconds
452 * This offset is added to Time() to offset the system time by the specified
454 * @param delta The number of seconds to offset
455 * @return The old time delta
457 int SetTimeDelta(int delta);
459 /** Get the time offset in seconds
460 * @return The current time delta (in seconds)
464 /** Process a user whos socket has been flagged as active
465 * @param cu The user to process
466 * @return There is no actual return value, however upon exit, the user 'cu' may have been
467 * marked for deletion in the global CullList.
469 caller1<void, User*> ProcessUser;
471 /** Bind all ports specified in the configuration file.
472 * @param bail True if the function should bail back to the shell on failure
473 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
474 * @return The number of ports actually bound without error
476 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
478 /** Binds a socket on an already open file descriptor
479 * @param sockfd A valid file descriptor of an open socket
480 * @param port The port number to bind to
481 * @param addr The address to bind to (IP only)
482 * @return True if the port was bound successfully
484 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
486 /** Adds a server name to the list of servers we've seen
487 * @param The servername to add
489 void AddServerName(const std::string &servername);
491 /** Finds a cached char* pointer of a server name,
492 * This is used to optimize User by storing only the pointer to the name
493 * @param The servername to find
494 * @return A pointer to this name, gauranteed to never become invalid
496 const char* FindServerNamePtr(const std::string &servername);
498 /** Returns true if we've seen the given server name before
499 * @param The servername to find
500 * @return True if we've seen this server name before
502 bool FindServerName(const std::string &servername);
504 /** Gets the GECOS (description) field of the given server.
505 * If the servername is not that of the local server, the name
506 * is passed to handling modules which will attempt to determine
507 * the GECOS that bleongs to the given servername.
508 * @param servername The servername to find the description of
509 * @return The description of this server, or of the local server
511 std::string GetServerDescription(const char* servername);
513 /** Find a user in the nick hash.
514 * If the user cant be found in the nick hash check the uuid hash
515 * @param nick The nickname to find
516 * @return A pointer to the user, or NULL if the user does not exist
518 User* FindNick(const std::string &nick);
520 /** Find a user in the nick hash.
521 * If the user cant be found in the nick hash check the uuid hash
522 * @param nick The nickname to find
523 * @return A pointer to the user, or NULL if the user does not exist
525 User* FindNick(const char* nick);
527 /** Find a user in the nick hash ONLY
529 User* FindNickOnly(const char* nick);
531 /** Find a user in the nick hash ONLY
533 User* FindNickOnly(const std::string &nick);
535 /** Find a channel in the channels hash
536 * @param chan The channel to find
537 * @return A pointer to the channel, or NULL if the channel does not exist
539 Channel* FindChan(const std::string &chan);
541 /** Find a channel in the channels hash
542 * @param chan The channel to find
543 * @return A pointer to the channel, or NULL if the channel does not exist
545 Channel* FindChan(const char* chan);
547 /** Check for a 'die' tag in the config file, and abort if found
548 * @return Depending on the configuration, this function may never return
552 /** Check we aren't running as root, and exit if we are
553 * @return Depending on the configuration, this function may never return
557 /** Determine the right path for, and open, the logfile
558 * @param argv The argv passed to main() initially, used to calculate program path
559 * @param argc The argc passed to main() initially, used to calculate program path
560 * @return True if the log could be opened, false if otherwise
562 bool OpenLog(char** argv, int argc);
564 /** Close the currently open log file
568 /** Return true if a channel name is valid
569 * @param chname A channel name to verify
570 * @return True if the name is valid
572 bool IsChannel(const char *chname);
574 /** Return true if str looks like a server ID
575 * @param string to check against
577 bool IsSID(const std::string &str);
579 /** Rehash the local server
583 /** Handles incoming signals after being set
584 * @param signal the signal recieved
586 void SignalHandler(int signal);
588 /** Sets the signal recieved
589 * @param signal the signal recieved
591 static void SetSignal(int signal);
593 /** Causes the server to exit after unloading modules and
594 * closing all open file descriptors.
596 * @param The exit code to give to the operating system
597 * (See the ExitStatus enum for valid values)
599 void Exit(int status);
601 /** Causes the server to exit immediately with exit code 0.
602 * The status code is required for signal handlers, and ignored.
604 static void QuickExit(int status);
606 /** Return a count of channels on the network
607 * @return The number of channels
611 /** Send an error notice to all local users, opered and unopered
612 * @param s The error string to send
614 void SendError(const std::string &s);
616 /** Return true if a nickname is valid
617 * @param n A nickname to verify
618 * @return True if the nick is valid
620 caller1<bool, const char*> IsNick;
622 /** Return true if an ident is valid
623 * @param An ident to verify
624 * @return True if the ident is valid
626 caller1<bool, const char*> IsIdent;
628 /** Find a username by their file descriptor.
629 * It is preferred to use this over directly accessing the fd_ref_table array.
630 * @param socket The file descriptor of a user
631 * @return A pointer to the user if the user exists locally on this descriptor
633 caller1<User*, int> FindDescriptor;
635 /** Add a dns Resolver class to this server's active set
636 * @param r The resolver to add
637 * @param cached If this value is true, then the cache will
638 * be searched for the DNS result, immediately. If the value is
639 * false, then a request will be sent to the nameserver, and the
640 * result will not be immediately available. You should usually
641 * use the boolean value which you passed to the Resolver
642 * constructor, which Resolver will set appropriately depending
643 * on if cached results are available and haven't expired. It is
644 * however safe to force this value to false, forcing a remote DNS
645 * lookup, but not an update of the cache.
646 * @return True if the operation completed successfully. Note that
647 * if this method returns true, you should not attempt to access
648 * the resolver class you pass it after this call, as depending upon
649 * the request given, the object may be deleted!
651 bool AddResolver(Resolver* r, bool cached);
653 /** Add a command to this server's command parser
654 * @param f A Command command handler object to add
655 * @throw ModuleException Will throw ModuleExcption if the command already exists
657 void AddCommand(Command *f);
659 /** Send a modechange.
660 * The parameters provided are identical to that sent to the
661 * handler for class cmd_mode.
662 * @param parameters The mode parameters
663 * @param pcnt The number of items you have given in the first parameter
664 * @param user The user to send error messages to
666 void SendMode(const char **parameters, int pcnt, User *user);
668 /** Match two strings using pattern matching.
669 * This operates identically to the global function match(),
670 * except for that it takes std::string arguments rather than
672 * @param sliteral The literal string to match against
673 * @param spattern The pattern to match against. CIDR and globs are supported.
675 bool MatchText(const std::string &sliteral, const std::string &spattern);
677 /** Call the handler for a given command.
678 * @param commandname The command whos handler you wish to call
679 * @param parameters The mode parameters
680 * @param pcnt The number of items you have given in the first parameter
681 * @param user The user to execute the command as
682 * @return True if the command handler was called successfully
684 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user);
686 /** Return true if the command is a module-implemented command and the given parameters are valid for it
687 * @param parameters The mode parameters
688 * @param pcnt The number of items you have given in the first parameter
689 * @param user The user to test-execute the command as
690 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
692 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
694 /** Return true if the given parameter is a valid nick!user\@host mask
695 * @param mask A nick!user\@host masak to match against
696 * @return True i the mask is valid
698 bool IsValidMask(const std::string &mask);
700 /** Rehash the local server
704 /** Return the channel whos index number matches that provided
705 * @param The index number of the channel to fetch
706 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
708 Channel* GetChannelIndex(long index);
710 /** Dump text to a user target, splitting it appropriately to fit
711 * @param User the user to dump the text to
712 * @param LinePrefix text to prefix each complete line with
713 * @param TextStream the text to send to the user
715 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
717 /** Check if the given nickmask matches too many users, send errors to the given user
718 * @param nick A nickmask to match against
719 * @param user A user to send error text to
720 * @return True if the nick matches too many users
722 bool NickMatchesEveryone(const std::string &nick, User* user);
724 /** Check if the given IP mask matches too many users, send errors to the given user
725 * @param ip An ipmask to match against
726 * @param user A user to send error text to
727 * @return True if the ip matches too many users
729 bool IPMatchesEveryone(const std::string &ip, User* user);
731 /** Check if the given hostmask matches too many users, send errors to the given user
732 * @param mask A hostmask to match against
733 * @param user A user to send error text to
734 * @return True if the host matches too many users
736 bool HostMatchesEveryone(const std::string &mask, User* user);
738 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
739 * @param str A string containing a time in the form 1y2w3d4h6m5s
740 * (one year, two weeks, three days, four hours, six minutes and five seconds)
741 * @return The total number of seconds
743 long Duration(const std::string &str);
745 /** Attempt to compare a password to a string from the config file.
746 * This will be passed to handling modules which will compare the data
747 * against possible hashed equivalents in the input string.
748 * @param ex The object (user, server, whatever) causing the comparison.
749 * @param data The data from the config file
750 * @param input The data input by the oper
751 * @param hashtype The hash from the config file
752 * @return 0 if the strings match, 1 or -1 if they do not
754 int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
756 /** Check if a given server is a uline.
757 * An empty string returns true, this is by design.
758 * @param server The server to check for uline status
759 * @return True if the server is a uline OR the string is empty
761 bool ULine(const char* server);
763 /** Returns true if the uline is 'silent' (doesnt generate
764 * remote connect notices etc).
766 bool SilentULine(const char* server);
768 /** Returns the subversion revision ID of this ircd
769 * @return The revision ID or an empty string
771 std::string GetRevision();
773 /** Returns the full version string of this ircd
774 * @return The version string
776 std::string GetVersionString();
778 /** Attempt to write the process id to a given file
779 * @param filename The PID file to attempt to write to
780 * @return This function may bail if the file cannot be written
782 void WritePID(const std::string &filename);
784 /** This constructor initialises all the subsystems and reads the config file.
785 * @param argc The argument count passed to main()
786 * @param argv The argument list passed to main()
787 * @throw <anything> If anything is thrown from here and makes it to
788 * you, you should probably just give up and go home. Yes, really.
789 * It's that bad. Higher level classes should catch any non-fatal exceptions.
791 InspIRCd(int argc, char** argv);
793 /** Output a log message to the ircd.log file
794 * The text will only be output if the current loglevel
795 * is less than or equal to the level you provide
796 * @param level A log level from the DebugLevel enum
797 * @param text Format string of to write to the log
798 * @param ... Format arguments of text to write to the log
800 void Log(int level, const char* text, ...);
802 /** Output a log message to the ircd.log file
803 * The text will only be output if the current loglevel
804 * is less than or equal to the level you provide
805 * @param level A log level from the DebugLevel enum
806 * @param text Text to write to the log
808 void Log(int level, const std::string &text);
810 /** Send a line of WHOIS data to a user.
811 * @param user user to send the line to
812 * @param dest user being WHOISed
813 * @param numeric Numeric to send
814 * @param text Text of the numeric
816 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
818 /** Send a line of WHOIS data to a user.
819 * @param user user to send the line to
820 * @param dest user being WHOISed
821 * @param numeric Numeric to send
822 * @param format Format string for the numeric
823 * @param ... Parameters for the format string
825 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
827 /** Quit a user for excess flood, and if they are not
828 * fully registered yet, temporarily zline their IP.
829 * @param current user to quit
831 caller1<void, User*> FloodQuitUser;
833 /** Restart the server.
834 * This function will not return. If an error occurs,
835 * it will throw an instance of CoreException.
836 * @param reason The restart reason to show to all clients
837 * @throw CoreException An instance of CoreException indicating the error from execv().
839 void Restart(const std::string &reason);
841 /** Prepare the ircd for restart or shutdown.
842 * This function unloads all modules which can be unloaded,
843 * closes all open sockets, and closes the logfile.
847 /** This copies the user and channel hash_maps into new hash maps.
848 * This frees memory used by the hash_map allocator (which it neglects
849 * to free, most of the time, using tons of ram)
851 void RehashUsersAndChans();
853 /** Resets the cached max bans value on all channels.
858 /** Return a time_t as a human-readable string.
860 std::string TimeString(time_t curtime);
862 /** Begin execution of the server.
863 * NOTE: this function NEVER returns. Internally,
864 * it will repeatedly loop.
865 * @return The return value for this function is undefined.
869 /** Force all BufferedSockets to be removed which are due to
872 void BufferedSocketCull();
874 char* GetReadBuffer()
876 return this->ReadBuffer;