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(FloodQuitUserHandler, void, User*);
278 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
279 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
280 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
282 /* Forward declaration - required */
284 class BanCacheManager;
286 /** The background thread for config reading, so that reading from executable includes
289 class CoreExport ConfigReaderThread : public Thread
291 InspIRCd* ServerInstance;
294 std::string TheUserUID;
296 ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid)
297 : Thread(), ServerInstance(Instance), do_bail(bail), done(false), TheUserUID(useruid)
301 virtual ~ConfigReaderThread()
306 bool IsDone() { return done; }
309 /** The main class of the irc server.
310 * This class contains instances of all the other classes
311 * in this software, with the exception of the base class,
312 * classbase. Amongst other things, it contains a ModeParser,
313 * a DNS object, a CommandParser object, and a list of active
314 * Module objects, and facilities for Module objects to
315 * interact with the core system it implements.
317 class CoreExport InspIRCd : public classbase
320 /** Holds the current UID. Used to generate the next one.
322 char current_uid[UUID_LENGTH];
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 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
334 * @param TIME the current time
336 void DoSocketTimeouts(time_t TIME);
338 /** Increments the current UID by one.
340 void IncrementUID(int pos);
342 /** Perform background user events such as PING checks
344 void DoBackgroundUserStuff();
346 /** Returns true when all modules have done pre-registration checks on a user
347 * @param user The user to verify
348 * @return True if all modules have finished checking this user
350 bool AllModulesReportReady(User* user);
352 /** Logfile pathname specified on the commandline, or empty string
354 char LogFileName[MAXBUF];
356 /** The current time, updated in the mainloop
360 /** The time that was recorded last time around the mainloop
364 /** A 64k buffer used to read socket data into
365 * NOTE: update ValidateNetBufferSize if you change this
367 char ReadBuffer[65535];
369 /** Used when connecting clients
371 irc::sockets::insp_sockaddr client, server;
373 /** Used when connecting clients
383 /** Global cull list, will be processed on next iteration
385 CullList GlobalCulls;
389 ProcessUserHandler HandleProcessUser;
390 IsNickHandler HandleIsNick;
391 IsIdentHandler HandleIsIdent;
392 FloodQuitUserHandler HandleFloodQuitUser;
393 IsChannelHandler HandleIsChannel;
394 IsSIDHandler HandleIsSID;
395 RehashHandler HandleRehash;
397 /** BufferedSocket classes pending deletion after being closed.
398 * We don't delete these immediately as this may cause a segmentation fault.
400 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
402 /** 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
405 * SendMode expects a User* to send the numeric replies
406 * back to, so we create it a fake user that isnt in the user
407 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
408 * falls into the abyss :p
412 /** Returns the next available UID for this server.
414 std::string GetUID();
416 /** Find a user in the UUID hash
417 * @param nick The nickname to find
418 * @return A pointer to the user, or NULL if the user does not exist
420 User* FindUUID(const std::string &);
422 /** Find a user in the UUID hash
423 * @param nick The nickname to find
424 * @return A pointer to the user, or NULL if the user does not exist
426 User* FindUUID(const char *);
428 /** Build the ISUPPORT string by triggering all modules On005Numeric events
430 void BuildISupport();
432 /** List of server names we've seen.
434 servernamelist servernames;
436 /** Time this ircd was booted
440 /** Config file pathname specified on the commandline or via ./configure
442 char ConfigFileName[MAXBUF];
444 /** Mode handler, handles mode setting and removal
448 /** Command parser, handles client to server commands
450 CommandParser* Parser;
452 /** Socket engine, handles socket activity events
456 /** Thread engine, Handles threading where required
458 ThreadEngine* Threads;
460 /** The thread/class used to read config files in REHASH and on startup
462 ConfigReaderThread* ConfigThread;
464 /** LogManager handles logging.
468 /** ModuleManager contains everything related to loading/unloading
471 ModuleManager* Modules;
473 /** BanCacheManager is used to speed up checking of restrictions on connection
476 BanCacheManager *BanCache;
478 /** Stats class, holds miscellaneous stats counters
482 /** Server Config class, holds configuration file data
484 ServerConfig* Config;
486 /** Snomask manager - handles routing of snomask messages
491 /** DNS class, provides resolver facilities to the core and modules
495 /** Timer manager class, triggers Timer timer events
497 TimerManager* Timers;
499 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
501 XLineManager* XLines;
503 /** User manager. Various methods and data associated with users.
507 /** Channel list, a hash_map containing all channels XXX move to channel manager class
511 /** Set to the current signal recieved
515 /** Protocol interface, overridden by server protocol modules
517 ProtocolInterface* PI;
519 /** Get the current time
520 * Because this only calls time() once every time around the mainloop,
521 * it is much faster than calling time() directly.
522 * @return The current time as an epoch value (time_t)
526 /** Process a user whos socket has been flagged as active
527 * @param cu The user to process
528 * @return There is no actual return value, however upon exit, the user 'cu' may have been
529 * marked for deletion in the global CullList.
531 caller1<void, User*> ProcessUser;
533 /** Bind all ports specified in the configuration file.
534 * @param bail True if the function should bail back to the shell on failure
535 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
536 * @return The number of ports actually bound without error
538 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
540 /** Binds a socket on an already open file descriptor
541 * @param sockfd A valid file descriptor of an open socket
542 * @param port The port number to bind to
543 * @param addr The address to bind to (IP only)
544 * @return True if the port was bound successfully
546 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
548 /** Adds a server name to the list of servers we've seen
549 * @param The servername to add
551 void AddServerName(const std::string &servername);
553 /** Finds a cached char* pointer of a server name,
554 * This is used to optimize User by storing only the pointer to the name
555 * @param The servername to find
556 * @return A pointer to this name, gauranteed to never become invalid
558 const char* FindServerNamePtr(const std::string &servername);
560 /** Returns true if we've seen the given server name before
561 * @param The servername to find
562 * @return True if we've seen this server name before
564 bool FindServerName(const std::string &servername);
566 /** Gets the GECOS (description) field of the given server.
567 * If the servername is not that of the local server, the name
568 * is passed to handling modules which will attempt to determine
569 * the GECOS that bleongs to the given servername.
570 * @param servername The servername to find the description of
571 * @return The description of this server, or of the local server
573 std::string GetServerDescription(const char* servername);
575 /** Find a user in the nick hash.
576 * If the user cant be found in the nick hash check the uuid hash
577 * @param nick The nickname to find
578 * @return A pointer to the user, or NULL if the user does not exist
580 User* FindNick(const std::string &nick);
582 /** Find a user in the nick hash.
583 * If the user cant be found in the nick hash check the uuid hash
584 * @param nick The nickname to find
585 * @return A pointer to the user, or NULL if the user does not exist
587 User* FindNick(const char* nick);
589 /** Find a user in the nick hash ONLY
591 User* FindNickOnly(const char* nick);
593 /** Find a user in the nick hash ONLY
595 User* FindNickOnly(const std::string &nick);
597 /** Find a channel in the channels hash
598 * @param chan The channel to find
599 * @return A pointer to the channel, or NULL if the channel does not exist
601 Channel* FindChan(const std::string &chan);
603 /** Find a channel in the channels hash
604 * @param chan The channel to find
605 * @return A pointer to the channel, or NULL if the channel does not exist
607 Channel* FindChan(const char* chan);
609 /** Check for a 'die' tag in the config file, and abort if found
610 * @return Depending on the configuration, this function may never return
614 /** Check we aren't running as root, and exit if we are
615 * @return Depending on the configuration, this function may never return
619 /** Determine the right path for, and open, the logfile
620 * @param argv The argv passed to main() initially, used to calculate program path
621 * @param argc The argc passed to main() initially, used to calculate program path
622 * @return True if the log could be opened, false if otherwise
624 bool OpenLog(char** argv, int argc);
626 /** Return true if a channel name is valid
627 * @param chname A channel name to verify
628 * @return True if the name is valid
630 caller2<bool, const char*, size_t> IsChannel;
632 /** Return true if str looks like a server ID
633 * @param string to check against
635 caller1<bool, const std::string&> IsSID;
637 /** Rehash the local server
639 caller1<void, const std::string&> Rehash;
641 /** Handles incoming signals after being set
642 * @param signal the signal recieved
644 void SignalHandler(int signal);
646 /** Sets the signal recieved
647 * @param signal the signal recieved
649 static void SetSignal(int signal);
651 /** Causes the server to exit after unloading modules and
652 * closing all open file descriptors.
654 * @param The exit code to give to the operating system
655 * (See the ExitStatus enum for valid values)
657 void Exit(int status);
659 /** Causes the server to exit immediately with exit code 0.
660 * The status code is required for signal handlers, and ignored.
662 static void QuickExit(int status);
664 /** Return a count of channels on the network
665 * @return The number of channels
669 /** Send an error notice to all local users, opered and unopered
670 * @param s The error string to send
672 void SendError(const std::string &s);
674 /** Return true if a nickname is valid
675 * @param n A nickname to verify
676 * @return True if the nick is valid
678 caller2<bool, const char*, size_t> IsNick;
680 /** Return true if an ident is valid
681 * @param An ident to verify
682 * @return True if the ident is valid
684 caller1<bool, const char*> IsIdent;
686 /** Add a dns Resolver class to this server's active set
687 * @param r The resolver to add
688 * @param cached If this value is true, then the cache will
689 * be searched for the DNS result, immediately. If the value is
690 * false, then a request will be sent to the nameserver, and the
691 * result will not be immediately available. You should usually
692 * use the boolean value which you passed to the Resolver
693 * constructor, which Resolver will set appropriately depending
694 * on if cached results are available and haven't expired. It is
695 * however safe to force this value to false, forcing a remote DNS
696 * lookup, but not an update of the cache.
697 * @return True if the operation completed successfully. Note that
698 * if this method returns true, you should not attempt to access
699 * the resolver class you pass it after this call, as depending upon
700 * the request given, the object may be deleted!
702 bool AddResolver(Resolver* r, bool cached);
704 /** Add a command to this server's command parser
705 * @param f A Command command handler object to add
706 * @throw ModuleException Will throw ModuleExcption if the command already exists
708 void AddCommand(Command *f);
710 /** Send a modechange.
711 * The parameters provided are identical to that sent to the
712 * handler for class cmd_mode.
713 * @param parameters The mode parameters
714 * @param user The user to send error messages to
716 void SendMode(const std::vector<std::string>& parameters, User *user);
718 /** Match two strings using pattern matching, optionally, with a map
719 * to check case against (may be NULL). If map is null, match will be case insensitive.
720 * @param str The literal string to match against
721 * @param mask The glob pattern to match against.
723 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
724 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
726 /** Match two strings using pattern matching, optionally, with a map
727 * to check case against (may be NULL). If map is null, match will be case insensitive.
728 * Supports CIDR patterns as well as globs.
729 * @param str The literal string to match against
730 * @param mask The glob or CIDR pattern to match against.
732 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
733 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
735 /** Call the handler for a given command.
736 * @param commandname The command whos handler you wish to call
737 * @param parameters The mode parameters
738 * @param pcnt The number of items you have given in the first parameter
739 * @param user The user to execute the command as
740 * @return True if the command handler was called successfully
742 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
744 /** Return true if the command is a module-implemented command and the given parameters are valid for it
745 * @param parameters The mode parameters
746 * @param pcnt The number of items you have given in the first parameter
747 * @param user The user to test-execute the command as
748 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
750 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
752 /** Return true if the given parameter is a valid nick!user\@host mask
753 * @param mask A nick!user\@host masak to match against
754 * @return True i the mask is valid
756 bool IsValidMask(const std::string &mask);
758 /** Rehash the local server
762 /** Return the channel whos index number matches that provided
763 * @param The index number of the channel to fetch
764 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
766 Channel* GetChannelIndex(long index);
768 /** Dump text to a user target, splitting it appropriately to fit
769 * @param User the user to dump the text to
770 * @param LinePrefix text to prefix each complete line with
771 * @param TextStream the text to send to the user
773 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
775 /** Check if the given nickmask matches too many users, send errors to the given user
776 * @param nick A nickmask to match against
777 * @param user A user to send error text to
778 * @return True if the nick matches too many users
780 bool NickMatchesEveryone(const std::string &nick, User* user);
782 /** Check if the given IP mask matches too many users, send errors to the given user
783 * @param ip An ipmask to match against
784 * @param user A user to send error text to
785 * @return True if the ip matches too many users
787 bool IPMatchesEveryone(const std::string &ip, User* user);
789 /** Check if the given hostmask matches too many users, send errors to the given user
790 * @param mask A hostmask to match against
791 * @param user A user to send error text to
792 * @return True if the host matches too many users
794 bool HostMatchesEveryone(const std::string &mask, User* user);
796 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
797 * @param str A string containing a time in the form 1y2w3d4h6m5s
798 * (one year, two weeks, three days, four hours, six minutes and five seconds)
799 * @return The total number of seconds
801 long Duration(const std::string &str);
803 /** Attempt to compare a password to a string from the config file.
804 * This will be passed to handling modules which will compare the data
805 * against possible hashed equivalents in the input string.
806 * @param ex The object (user, server, whatever) causing the comparison.
807 * @param data The data from the config file
808 * @param input The data input by the oper
809 * @param hashtype The hash from the config file
810 * @return 0 if the strings match, 1 or -1 if they do not
812 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
814 /** Check if a given server is a uline.
815 * An empty string returns true, this is by design.
816 * @param server The server to check for uline status
817 * @return True if the server is a uline OR the string is empty
819 bool ULine(const char* server);
821 /** Returns true if the uline is 'silent' (doesnt generate
822 * remote connect notices etc).
824 bool SilentULine(const char* server);
826 /** Returns the subversion revision ID of this ircd
827 * @return The revision ID or an empty string
829 std::string GetRevision();
831 /** Returns the full version string of this ircd
832 * @return The version string
834 std::string GetVersionString();
836 /** Attempt to write the process id to a given file
837 * @param filename The PID file to attempt to write to
838 * @return This function may bail if the file cannot be written
840 void WritePID(const std::string &filename);
842 /** This constructor initialises all the subsystems and reads the config file.
843 * @param argc The argument count passed to main()
844 * @param argv The argument list passed to main()
845 * @throw <anything> If anything is thrown from here and makes it to
846 * you, you should probably just give up and go home. Yes, really.
847 * It's that bad. Higher level classes should catch any non-fatal exceptions.
849 InspIRCd(int argc, char** argv);
851 /** Send a line of WHOIS data to a user.
852 * @param user user to send the line to
853 * @param dest user being WHOISed
854 * @param numeric Numeric to send
855 * @param text Text of the numeric
857 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
859 /** Send a line of WHOIS data to a user.
860 * @param user user to send the line to
861 * @param dest user being WHOISed
862 * @param numeric Numeric to send
863 * @param format Format string for the numeric
864 * @param ... Parameters for the format string
866 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
868 /** Quit a user for excess flood, and if they are not
869 * fully registered yet, temporarily zline their IP.
870 * @param current user to quit
872 caller1<void, User*> FloodQuitUser;
874 /** Restart the server.
875 * This function will not return. If an error occurs,
876 * it will throw an instance of CoreException.
877 * @param reason The restart reason to show to all clients
878 * @throw CoreException An instance of CoreException indicating the error from execv().
880 void Restart(const std::string &reason);
882 /** Prepare the ircd for restart or shutdown.
883 * This function unloads all modules which can be unloaded,
884 * closes all open sockets, and closes the logfile.
888 /** This copies the user and channel hash_maps into new hash maps.
889 * This frees memory used by the hash_map allocator (which it neglects
890 * to free, most of the time, using tons of ram)
892 void RehashUsersAndChans();
894 /** Resets the cached max bans value on all channels.
899 /** Return a time_t as a human-readable string.
901 std::string TimeString(time_t curtime);
903 /** Begin execution of the server.
904 * NOTE: this function NEVER returns. Internally,
905 * it will repeatedly loop.
906 * @return The return value for this function is undefined.
910 /** Force all BufferedSockets to be removed which are due to
913 void BufferedSocketCull();
915 /** Adds an extban char to the 005 token.
917 void AddExtBanChar(char c);
919 char* GetReadBuffer()
921 return this->ReadBuffer;