1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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__
17 #define _FILE_OFFSET_BITS 64
18 #ifndef _LARGEFILE_SOURCE
19 #define _LARGEFILE_SOURCE
25 #define printf_c printf
27 #include "inspircd_win32wrapper.h"
28 /** Windows defines these already */
34 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
36 #define CUSTOM_PRINTF(STRING, FIRST)
39 // Required system headers.
57 /** A list of failed port bindings, used for informational purposes on startup */
58 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
60 /** A cached text file stored with its contents as lines
62 typedef std::deque< std::string > file_cache;
64 /** A configuration key and value pair
66 typedef std::pair< std::string, std::string > KeyVal;
68 /** A list of related configuration keys and values
70 typedef std::vector< KeyVal > KeyValList;
72 /** An entire config file, built up of KeyValLists
74 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
76 #include "inspircd_config.h"
85 #include "usermanager.h"
88 #include "command_parse.h"
90 #include "socketengine.h"
92 #include "cull_list.h"
93 #include "filelogger.h"
96 #include "configreader.h"
97 #include "inspstring.h"
99 #include "threadengine.h"
102 #warning Potentially broken system, PATH_MAX undefined
103 #define PATH_MAX 4096
107 * Used to define the maximum number of parameters a command may have.
109 #define MAXPARAMETERS 127
111 /** Returned by some functions to indicate failure.
115 /** Support for librodent -
116 * see http://www.chatspike.net/index.php?z=64
118 #define ETIREDHAMSTERS EAGAIN
120 /** Template function to convert any input type to std::string
122 template<typename T> inline std::string ConvNumeric(const T &in)
124 if (in == 0) return "0";
129 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
136 std::reverse(res,out);
140 /** Template function to convert any input type to std::string
142 inline std::string ConvToStr(const int in)
144 return ConvNumeric(in);
147 /** Template function to convert any input type to std::string
149 inline std::string ConvToStr(const long in)
151 return ConvNumeric(in);
154 /** Template function to convert any input type to std::string
156 inline std::string ConvToStr(const char* in)
161 /** Template function to convert any input type to std::string
163 inline std::string ConvToStr(const bool in)
165 return (in ? "1" : "0");
168 /** Template function to convert any input type to std::string
170 inline std::string ConvToStr(char in)
172 return std::string(in,1);
175 /** Template function to convert any input type to std::string
177 template <class T> inline std::string ConvToStr(const T &in)
179 std::stringstream tmp;
180 if (!(tmp << in)) return std::string();
184 /** Template function to convert any input type to any other type
185 * (usually an integer or numeric type)
187 template<typename T> inline long ConvToInt(const T &in)
189 std::stringstream tmp;
190 if (!(tmp << in)) return 0;
191 return atoi(tmp.str().c_str());
194 /** Template function to convert integer to char, storing result in *res and
195 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
196 * @param T input value
197 * @param V result value
198 * @param R base to convert to
200 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
202 if (base < 2 || base > 16) { *res = 0; return res; }
206 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
210 if ( in < 0 && base == 10) *out++ = '-';
211 std::reverse( res, out );
216 /** This class contains various STATS counters
217 * It is used by the InspIRCd class, which internally
218 * has an instance of it.
220 class serverstats : public classbase
223 /** Number of accepted connections
225 unsigned long statsAccept;
226 /** Number of failed accepts
228 unsigned long statsRefused;
229 /** Number of unknown commands seen
231 unsigned long statsUnknown;
232 /** Number of nickname collisions handled
234 unsigned long statsCollisions;
235 /** Number of DNS queries sent out
237 unsigned long statsDns;
238 /** Number of good DNS replies received
239 * NOTE: This may not tally to the number sent out,
240 * due to timeouts and other latency issues.
242 unsigned long statsDnsGood;
243 /** Number of bad (negative) DNS replies received
244 * NOTE: This may not tally to the number sent out,
245 * due to timeouts and other latency issues.
247 unsigned long statsDnsBad;
248 /** Number of inbound connections seen
250 unsigned long statsConnects;
251 /** Total bytes of data transmitted
254 /** Total bytes of data received
257 /** Cpu usage at last sample
260 /** Time last sample was read
263 /** The constructor initializes all the counts to zero
266 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
267 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
274 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
275 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
276 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
277 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
278 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
279 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
280 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
281 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
283 /* Forward declaration - required */
285 class BanCacheManager;
287 /** The background thread for config reading, so that reading from executable includes
290 class CoreExport ConfigReaderThread : public Thread
292 InspIRCd* ServerInstance;
295 std::string TheUserUID;
297 ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid)
298 : Thread(), ServerInstance(Instance), do_bail(bail), done(false), TheUserUID(useruid)
302 virtual ~ConfigReaderThread()
307 bool IsDone() { return done; }
310 /** The main class of the irc server.
311 * This class contains instances of all the other classes
312 * in this software, with the exception of the base class,
313 * classbase. Amongst other things, it contains a ModeParser,
314 * a DNS object, a CommandParser object, and a list of active
315 * Module objects, and facilities for Module objects to
316 * interact with the core system it implements.
318 class CoreExport InspIRCd : public classbase
321 /** Holds the current UID. Used to generate the next one.
323 char current_uid[UUID_LENGTH];
325 /** Set up the signal handlers
329 /** Daemonize the ircd and close standard input/output streams
330 * @return True if the program daemonized succesfully
334 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
335 * @param TIME the current time
337 void DoSocketTimeouts(time_t TIME);
339 /** Increments the current UID by one.
341 void IncrementUID(int pos);
343 /** Perform background user events such as PING checks
345 void DoBackgroundUserStuff();
347 /** Returns true when all modules have done pre-registration checks on a user
348 * @param user The user to verify
349 * @return True if all modules have finished checking this user
351 bool AllModulesReportReady(User* user);
353 /** Logfile pathname specified on the commandline, or empty string
355 char LogFileName[MAXBUF];
357 /** The current time, updated in the mainloop
361 /** The time that was recorded last time around the mainloop
365 /** A 64k buffer used to read socket data into
366 * NOTE: update ValidateNetBufferSize if you change this
368 char ReadBuffer[65535];
370 /** Used when connecting clients
372 irc::sockets::insp_sockaddr client, server;
374 /** Used when connecting clients
384 /** Global cull list, will be processed on next iteration
386 CullList GlobalCulls;
390 ProcessUserHandler HandleProcessUser;
391 IsNickHandler HandleIsNick;
392 IsIdentHandler HandleIsIdent;
393 FindDescriptorHandler HandleFindDescriptor;
394 FloodQuitUserHandler HandleFloodQuitUser;
395 IsChannelHandler HandleIsChannel;
396 IsSIDHandler HandleIsSID;
397 RehashHandler HandleRehash;
399 /** BufferedSocket classes pending deletion after being closed.
400 * We don't delete these immediately as this may cause a segmentation fault.
402 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
404 /** 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
407 * SendMode expects a User* to send the numeric replies
408 * back to, so we create it a fake user that isnt in the user
409 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
410 * falls into the abyss :p
414 /** Returns the next available UID for this server.
416 std::string GetUID();
418 /** Find a user in the UUID hash
419 * @param nick The nickname to find
420 * @return A pointer to the user, or NULL if the user does not exist
422 User* FindUUID(const std::string &);
424 /** Find a user in the UUID hash
425 * @param nick The nickname to find
426 * @return A pointer to the user, or NULL if the user does not exist
428 User* FindUUID(const char *);
430 /** Build the ISUPPORT string by triggering all modules On005Numeric events
432 void BuildISupport();
434 /** List of server names we've seen.
436 servernamelist servernames;
438 /** Time this ircd was booted
442 /** Config file pathname specified on the commandline or via ./configure
444 char ConfigFileName[MAXBUF];
446 /** Mode handler, handles mode setting and removal
450 /** Command parser, handles client to server commands
452 CommandParser* Parser;
454 /** Socket engine, handles socket activity events
458 /** Thread engine, Handles threading where required
460 ThreadEngine* Threads;
462 /** The thread/class used to read config files in REHASH and on startup
464 ConfigReaderThread* ConfigThread;
466 /** LogManager handles logging.
470 /** ModuleManager contains everything related to loading/unloading
473 ModuleManager* Modules;
475 /** BanCacheManager is used to speed up checking of restrictions on connection
478 BanCacheManager *BanCache;
480 /** Stats class, holds miscellaneous stats counters
484 /** Server Config class, holds configuration file data
486 ServerConfig* Config;
488 /** Snomask manager - handles routing of snomask messages
493 /** DNS class, provides resolver facilities to the core and modules
497 /** Timer manager class, triggers Timer timer events
499 TimerManager* Timers;
501 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
503 XLineManager* XLines;
505 /** User manager. Various methods and data associated with users.
509 /** Channel list, a hash_map containing all channels XXX move to channel manager class
513 /** Set to the current signal recieved
517 /** Protocol interface, overridden by server protocol modules
519 ProtocolInterface* PI;
521 /** Get the current time
522 * Because this only calls time() once every time around the mainloop,
523 * it is much faster than calling time() directly.
524 * @return The current time as an epoch value (time_t)
528 /** Process a user whos socket has been flagged as active
529 * @param cu The user to process
530 * @return There is no actual return value, however upon exit, the user 'cu' may have been
531 * marked for deletion in the global CullList.
533 caller1<void, User*> ProcessUser;
535 /** Bind all ports specified in the configuration file.
536 * @param bail True if the function should bail back to the shell on failure
537 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
538 * @return The number of ports actually bound without error
540 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
542 /** Binds a socket on an already open file descriptor
543 * @param sockfd A valid file descriptor of an open socket
544 * @param port The port number to bind to
545 * @param addr The address to bind to (IP only)
546 * @return True if the port was bound successfully
548 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
550 /** Adds a server name to the list of servers we've seen
551 * @param The servername to add
553 void AddServerName(const std::string &servername);
555 /** Finds a cached char* pointer of a server name,
556 * This is used to optimize User by storing only the pointer to the name
557 * @param The servername to find
558 * @return A pointer to this name, gauranteed to never become invalid
560 const char* FindServerNamePtr(const std::string &servername);
562 /** Returns true if we've seen the given server name before
563 * @param The servername to find
564 * @return True if we've seen this server name before
566 bool FindServerName(const std::string &servername);
568 /** Gets the GECOS (description) field of the given server.
569 * If the servername is not that of the local server, the name
570 * is passed to handling modules which will attempt to determine
571 * the GECOS that bleongs to the given servername.
572 * @param servername The servername to find the description of
573 * @return The description of this server, or of the local server
575 std::string GetServerDescription(const char* servername);
577 /** Find a user in the nick hash.
578 * If the user cant be found in the nick hash check the uuid hash
579 * @param nick The nickname to find
580 * @return A pointer to the user, or NULL if the user does not exist
582 User* FindNick(const std::string &nick);
584 /** Find a user in the nick hash.
585 * If the user cant be found in the nick hash check the uuid hash
586 * @param nick The nickname to find
587 * @return A pointer to the user, or NULL if the user does not exist
589 User* FindNick(const char* nick);
591 /** Find a user in the nick hash ONLY
593 User* FindNickOnly(const char* nick);
595 /** Find a user in the nick hash ONLY
597 User* FindNickOnly(const std::string &nick);
599 /** Find a channel in the channels hash
600 * @param chan The channel to find
601 * @return A pointer to the channel, or NULL if the channel does not exist
603 Channel* FindChan(const std::string &chan);
605 /** Find a channel in the channels hash
606 * @param chan The channel to find
607 * @return A pointer to the channel, or NULL if the channel does not exist
609 Channel* FindChan(const char* chan);
611 /** Check for a 'die' tag in the config file, and abort if found
612 * @return Depending on the configuration, this function may never return
616 /** Check we aren't running as root, and exit if we are
617 * @return Depending on the configuration, this function may never return
621 /** Determine the right path for, and open, the logfile
622 * @param argv The argv passed to main() initially, used to calculate program path
623 * @param argc The argc passed to main() initially, used to calculate program path
624 * @return True if the log could be opened, false if otherwise
626 bool OpenLog(char** argv, int argc);
628 /** Return true if a channel name is valid
629 * @param chname A channel name to verify
630 * @return True if the name is valid
632 caller2<bool, const char*, size_t> IsChannel;
634 /** Return true if str looks like a server ID
635 * @param string to check against
637 caller1<bool, const std::string&> IsSID;
639 /** Rehash the local server
641 caller1<void, const std::string&> Rehash;
643 /** Handles incoming signals after being set
644 * @param signal the signal recieved
646 void SignalHandler(int signal);
648 /** Sets the signal recieved
649 * @param signal the signal recieved
651 static void SetSignal(int signal);
653 /** Causes the server to exit after unloading modules and
654 * closing all open file descriptors.
656 * @param The exit code to give to the operating system
657 * (See the ExitStatus enum for valid values)
659 void Exit(int status);
661 /** Causes the server to exit immediately with exit code 0.
662 * The status code is required for signal handlers, and ignored.
664 static void QuickExit(int status);
666 /** Return a count of channels on the network
667 * @return The number of channels
671 /** Send an error notice to all local users, opered and unopered
672 * @param s The error string to send
674 void SendError(const std::string &s);
676 /** Return true if a nickname is valid
677 * @param n A nickname to verify
678 * @return True if the nick is valid
680 caller2<bool, const char*, size_t> IsNick;
682 /** Return true if an ident is valid
683 * @param An ident to verify
684 * @return True if the ident is valid
686 caller1<bool, const char*> IsIdent;
688 /** Find a username by their file descriptor.
689 * It is preferred to use this over directly accessing the fd_ref_table array.
690 * @param socket The file descriptor of a user
691 * @return A pointer to the user if the user exists locally on this descriptor
693 caller1<User*, int> FindDescriptor;
695 /** Add a dns Resolver class to this server's active set
696 * @param r The resolver to add
697 * @param cached If this value is true, then the cache will
698 * be searched for the DNS result, immediately. If the value is
699 * false, then a request will be sent to the nameserver, and the
700 * result will not be immediately available. You should usually
701 * use the boolean value which you passed to the Resolver
702 * constructor, which Resolver will set appropriately depending
703 * on if cached results are available and haven't expired. It is
704 * however safe to force this value to false, forcing a remote DNS
705 * lookup, but not an update of the cache.
706 * @return True if the operation completed successfully. Note that
707 * if this method returns true, you should not attempt to access
708 * the resolver class you pass it after this call, as depending upon
709 * the request given, the object may be deleted!
711 bool AddResolver(Resolver* r, bool cached);
713 /** Add a command to this server's command parser
714 * @param f A Command command handler object to add
715 * @throw ModuleException Will throw ModuleExcption if the command already exists
717 void AddCommand(Command *f);
719 /** Send a modechange.
720 * The parameters provided are identical to that sent to the
721 * handler for class cmd_mode.
722 * @param parameters The mode parameters
723 * @param user The user to send error messages to
725 void SendMode(const std::vector<std::string>& parameters, User *user);
727 /** Match two strings using pattern matching, optionally, with a map
728 * to check case against (may be NULL). If map is null, match will be case insensitive.
729 * @param str The literal string to match against
730 * @param mask The glob pattern to match against.
732 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
733 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
735 /** Match two strings using pattern matching, optionally, with a map
736 * to check case against (may be NULL). If map is null, match will be case insensitive.
737 * Supports CIDR patterns as well as globs.
738 * @param str The literal string to match against
739 * @param mask The glob or CIDR pattern to match against.
741 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
742 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
744 /** Call the handler for a given command.
745 * @param commandname The command whos handler you wish to call
746 * @param parameters The mode parameters
747 * @param pcnt The number of items you have given in the first parameter
748 * @param user The user to execute the command as
749 * @return True if the command handler was called successfully
751 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
753 /** Return true if the command is a module-implemented command and the given parameters are valid for it
754 * @param parameters The mode parameters
755 * @param pcnt The number of items you have given in the first parameter
756 * @param user The user to test-execute the command as
757 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
759 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
761 /** Return true if the given parameter is a valid nick!user\@host mask
762 * @param mask A nick!user\@host masak to match against
763 * @return True i the mask is valid
765 bool IsValidMask(const std::string &mask);
767 /** Rehash the local server
771 /** Return the channel whos index number matches that provided
772 * @param The index number of the channel to fetch
773 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
775 Channel* GetChannelIndex(long index);
777 /** Dump text to a user target, splitting it appropriately to fit
778 * @param User the user to dump the text to
779 * @param LinePrefix text to prefix each complete line with
780 * @param TextStream the text to send to the user
782 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
784 /** Check if the given nickmask matches too many users, send errors to the given user
785 * @param nick A nickmask to match against
786 * @param user A user to send error text to
787 * @return True if the nick matches too many users
789 bool NickMatchesEveryone(const std::string &nick, User* user);
791 /** Check if the given IP mask matches too many users, send errors to the given user
792 * @param ip An ipmask to match against
793 * @param user A user to send error text to
794 * @return True if the ip matches too many users
796 bool IPMatchesEveryone(const std::string &ip, User* user);
798 /** Check if the given hostmask matches too many users, send errors to the given user
799 * @param mask A hostmask to match against
800 * @param user A user to send error text to
801 * @return True if the host matches too many users
803 bool HostMatchesEveryone(const std::string &mask, User* user);
805 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
806 * @param str A string containing a time in the form 1y2w3d4h6m5s
807 * (one year, two weeks, three days, four hours, six minutes and five seconds)
808 * @return The total number of seconds
810 long Duration(const std::string &str);
812 /** Attempt to compare a password to a string from the config file.
813 * This will be passed to handling modules which will compare the data
814 * against possible hashed equivalents in the input string.
815 * @param ex The object (user, server, whatever) causing the comparison.
816 * @param data The data from the config file
817 * @param input The data input by the oper
818 * @param hashtype The hash from the config file
819 * @return 0 if the strings match, 1 or -1 if they do not
821 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
823 /** Check if a given server is a uline.
824 * An empty string returns true, this is by design.
825 * @param server The server to check for uline status
826 * @return True if the server is a uline OR the string is empty
828 bool ULine(const char* server);
830 /** Returns true if the uline is 'silent' (doesnt generate
831 * remote connect notices etc).
833 bool SilentULine(const char* server);
835 /** Returns the subversion revision ID of this ircd
836 * @return The revision ID or an empty string
838 std::string GetRevision();
840 /** Returns the full version string of this ircd
841 * @return The version string
843 std::string GetVersionString();
845 /** Attempt to write the process id to a given file
846 * @param filename The PID file to attempt to write to
847 * @return This function may bail if the file cannot be written
849 void WritePID(const std::string &filename);
851 /** This constructor initialises all the subsystems and reads the config file.
852 * @param argc The argument count passed to main()
853 * @param argv The argument list passed to main()
854 * @throw <anything> If anything is thrown from here and makes it to
855 * you, you should probably just give up and go home. Yes, really.
856 * It's that bad. Higher level classes should catch any non-fatal exceptions.
858 InspIRCd(int argc, char** argv);
860 /** Send a line of WHOIS data to a user.
861 * @param user user to send the line to
862 * @param dest user being WHOISed
863 * @param numeric Numeric to send
864 * @param text Text of the numeric
866 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
868 /** Send a line of WHOIS data to a user.
869 * @param user user to send the line to
870 * @param dest user being WHOISed
871 * @param numeric Numeric to send
872 * @param format Format string for the numeric
873 * @param ... Parameters for the format string
875 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
877 /** Quit a user for excess flood, and if they are not
878 * fully registered yet, temporarily zline their IP.
879 * @param current user to quit
881 caller1<void, User*> FloodQuitUser;
883 /** Restart the server.
884 * This function will not return. If an error occurs,
885 * it will throw an instance of CoreException.
886 * @param reason The restart reason to show to all clients
887 * @throw CoreException An instance of CoreException indicating the error from execv().
889 void Restart(const std::string &reason);
891 /** Prepare the ircd for restart or shutdown.
892 * This function unloads all modules which can be unloaded,
893 * closes all open sockets, and closes the logfile.
897 /** This copies the user and channel hash_maps into new hash maps.
898 * This frees memory used by the hash_map allocator (which it neglects
899 * to free, most of the time, using tons of ram)
901 void RehashUsersAndChans();
903 /** Resets the cached max bans value on all channels.
908 /** Return a time_t as a human-readable string.
910 std::string TimeString(time_t curtime);
912 /** Begin execution of the server.
913 * NOTE: this function NEVER returns. Internally,
914 * it will repeatedly loop.
915 * @return The return value for this function is undefined.
919 /** Force all BufferedSockets to be removed which are due to
922 void BufferedSocketCull();
924 /** Adds an extban char to the 005 token.
926 void AddExtBanChar(char c);
928 char* GetReadBuffer()
930 return this->ReadBuffer;