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 */
29 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
31 #define CUSTOM_PRINTF(STRING, FIRST)
34 // Required system headers.
51 /** A list of failed port bindings, used for informational purposes on startup */
52 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
54 /** A cached text file stored with its contents as lines
56 typedef std::deque< std::string > file_cache;
58 /** A configuration key and value pair
60 typedef std::pair< std::string, std::string > KeyVal;
62 /** A list of related configuration keys and values
64 typedef std::vector< KeyVal > KeyValList;
66 /** An entire config file, built up of KeyValLists
68 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
70 #include "inspircd_config.h"
79 #include "usermanager.h"
82 #include "command_parse.h"
84 #include "socketengine.h"
86 #include "cull_list.h"
87 #include "filelogger.h"
90 #include "configreader.h"
91 #include "inspstring.h"
95 #warning Potentially broken system, PATH_MAX undefined
100 * Used to define the maximum number of parameters a command may have.
102 #define MAXPARAMETERS 127
104 /** Returned by some functions to indicate failure.
108 /** Support for librodent -
109 * see http://www.chatspike.net/index.php?z=64
111 #define ETIREDHAMSTERS EAGAIN
113 /** Template function to convert any input type to std::string
115 template<typename T> inline std::string ConvNumeric(const T &in)
117 if (in == 0) return "0";
122 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
129 std::reverse(res,out);
133 /** Template function to convert any input type to std::string
135 inline std::string ConvToStr(const int in)
137 return ConvNumeric(in);
140 /** Template function to convert any input type to std::string
142 inline std::string ConvToStr(const long in)
144 return ConvNumeric(in);
147 /** Template function to convert any input type to std::string
149 inline std::string ConvToStr(const char* in)
154 /** Template function to convert any input type to std::string
156 inline std::string ConvToStr(const bool in)
158 return (in ? "1" : "0");
161 /** Template function to convert any input type to std::string
163 inline std::string ConvToStr(char in)
165 return std::string(in,1);
168 /** Template function to convert any input type to std::string
170 template <class T> inline std::string ConvToStr(const T &in)
172 std::stringstream tmp;
173 if (!(tmp << in)) return std::string();
177 /** Template function to convert any input type to any other type
178 * (usually an integer or numeric type)
180 template<typename T> inline long ConvToInt(const T &in)
182 std::stringstream tmp;
183 if (!(tmp << in)) return 0;
184 return atoi(tmp.str().c_str());
187 /** Template function to convert integer to char, storing result in *res and
188 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
189 * @param T input value
190 * @param V result value
191 * @param R base to convert to
193 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
195 if (base < 2 || base > 16) { *res = 0; return res; }
199 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
203 if ( in < 0 && base == 10) *out++ = '-';
204 std::reverse( res, out );
209 /** This class contains various STATS counters
210 * It is used by the InspIRCd class, which internally
211 * has an instance of it.
213 class serverstats : public classbase
216 /** Number of accepted connections
218 unsigned long statsAccept;
219 /** Number of failed accepts
221 unsigned long statsRefused;
222 /** Number of unknown commands seen
224 unsigned long statsUnknown;
225 /** Number of nickname collisions handled
227 unsigned long statsCollisions;
228 /** Number of DNS queries sent out
230 unsigned long statsDns;
231 /** Number of good DNS replies received
232 * NOTE: This may not tally to the number sent out,
233 * due to timeouts and other latency issues.
235 unsigned long statsDnsGood;
236 /** Number of bad (negative) DNS replies received
237 * NOTE: This may not tally to the number sent out,
238 * due to timeouts and other latency issues.
240 unsigned long statsDnsBad;
241 /** Number of inbound connections seen
243 unsigned long statsConnects;
244 /** Total bytes of data transmitted
247 /** Total bytes of data received
250 /** Cpu usage at last sample
253 /** Time last sample was read
256 /** The constructor initializes all the counts to zero
259 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
260 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
267 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
268 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
269 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
270 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
271 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
272 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
273 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
274 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
276 /* Forward declaration - required */
278 class BanCacheManager;
280 /** The background thread for config reading, so that reading from executable includes
283 class CoreExport ConfigReaderThread : public Thread
285 InspIRCd* ServerInstance;
287 std::string TheUserUID;
289 ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid) : Thread(), ServerInstance(Instance), do_bail(bail), TheUserUID(useruid)
293 virtual ~ConfigReaderThread()
300 /** The main class of the irc server.
301 * This class contains instances of all the other classes
302 * in this software, with the exception of the base class,
303 * classbase. Amongst other things, it contains a ModeParser,
304 * a DNS object, a CommandParser object, and a list of active
305 * Module objects, and facilities for Module objects to
306 * interact with the core system it implements.
308 class CoreExport InspIRCd : public classbase
311 /** Holds the current UID. Used to generate the next one.
313 char current_uid[UUID_LENGTH];
315 /** Set up the signal handlers
319 /** Daemonize the ircd and close standard input/output streams
320 * @return True if the program daemonized succesfully
324 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
325 * @param TIME the current time
327 void DoSocketTimeouts(time_t TIME);
329 /** Increments the current UID by one.
331 void IncrementUID(int pos);
333 /** Perform background user events such as PING checks
335 void DoBackgroundUserStuff();
337 /** Returns true when all modules have done pre-registration checks on a user
338 * @param user The user to verify
339 * @return True if all modules have finished checking this user
341 bool AllModulesReportReady(User* user);
343 /** Logfile pathname specified on the commandline, or empty string
345 char LogFileName[MAXBUF];
347 /** The current time, updated in the mainloop
351 /** The time that was recorded last time around the mainloop
355 /** A 64k buffer used to read socket data into
356 * NOTE: update ValidateNetBufferSize if you change this
358 char ReadBuffer[65535];
360 /** Used when connecting clients
362 irc::sockets::insp_sockaddr client, server;
364 /** Used when connecting clients
374 /** Global cull list, will be processed on next iteration
376 CullList GlobalCulls;
380 ProcessUserHandler HandleProcessUser;
381 IsNickHandler HandleIsNick;
382 IsIdentHandler HandleIsIdent;
383 FindDescriptorHandler HandleFindDescriptor;
384 FloodQuitUserHandler HandleFloodQuitUser;
385 IsChannelHandler HandleIsChannel;
386 IsSIDHandler HandleIsSID;
387 RehashHandler HandleRehash;
389 /** BufferedSocket classes pending deletion after being closed.
390 * We don't delete these immediately as this may cause a segmentation fault.
392 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
394 Mutex* RehashFinishMutex;
396 /** 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
399 * SendMode expects a User* to send the numeric replies
400 * back to, so we create it a fake user that isnt in the user
401 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
402 * falls into the abyss :p
406 /** Returns the next available UID for this server.
408 std::string GetUID();
410 /** Find a user in the UUID hash
411 * @param nick The nickname to find
412 * @return A pointer to the user, or NULL if the user does not exist
414 User* FindUUID(const std::string &);
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 char *);
422 /** Build the ISUPPORT string by triggering all modules On005Numeric events
424 void BuildISupport();
426 /** List of server names we've seen.
428 servernamelist servernames;
430 /** Time this ircd was booted
434 /** Config file pathname specified on the commandline or via ./configure
436 char ConfigFileName[MAXBUF];
438 /** Mode handler, handles mode setting and removal
442 /** Command parser, handles client to server commands
444 CommandParser* Parser;
446 /** Socket engine, handles socket activity events
450 /** Thread engine, Handles threading where required
452 ThreadEngine* Threads;
454 /** Mutex engine, handles mutexes for threading where required
456 MutexFactory* Mutexes;
458 /** The thread/class used to read config files in REHASH and on startup
460 ConfigReaderThread* ConfigThread;
462 /** LogManager handles logging.
466 /** ModuleManager contains everything related to loading/unloading
469 ModuleManager* Modules;
471 /** BanCacheManager is used to speed up checking of restrictions on connection
474 BanCacheManager *BanCache;
476 /** Stats class, holds miscellaneous stats counters
480 /** Server Config class, holds configuration file data
482 ServerConfig* Config;
484 /** Snomask manager - handles routing of snomask messages
489 /** DNS class, provides resolver facilities to the core and modules
493 /** Timer manager class, triggers Timer timer events
495 TimerManager* Timers;
497 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
499 XLineManager* XLines;
501 /** User manager. Various methods and data associated with users.
505 /** Channel list, a hash_map containing all channels XXX move to channel manager class
509 /** Set to the current signal recieved
513 /** Protocol interface, overridden by server protocol modules
515 ProtocolInterface* PI;
517 /** Get the current time
518 * Because this only calls time() once every time around the mainloop,
519 * it is much faster than calling time() directly.
520 * @return The current time as an epoch value (time_t)
524 /** Process a user whos socket has been flagged as active
525 * @param cu The user to process
526 * @return There is no actual return value, however upon exit, the user 'cu' may have been
527 * marked for deletion in the global CullList.
529 caller1<void, User*> ProcessUser;
531 /** Bind all ports specified in the configuration file.
532 * @param bail True if the function should bail back to the shell on failure
533 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
534 * @return The number of ports actually bound without error
536 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
538 /** Binds a socket on an already open file descriptor
539 * @param sockfd A valid file descriptor of an open socket
540 * @param port The port number to bind to
541 * @param addr The address to bind to (IP only)
542 * @return True if the port was bound successfully
544 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
546 /** Adds a server name to the list of servers we've seen
547 * @param The servername to add
549 void AddServerName(const std::string &servername);
551 /** Finds a cached char* pointer of a server name,
552 * This is used to optimize User by storing only the pointer to the name
553 * @param The servername to find
554 * @return A pointer to this name, gauranteed to never become invalid
556 const char* FindServerNamePtr(const std::string &servername);
558 /** Returns true if we've seen the given server name before
559 * @param The servername to find
560 * @return True if we've seen this server name before
562 bool FindServerName(const std::string &servername);
564 /** Gets the GECOS (description) field of the given server.
565 * If the servername is not that of the local server, the name
566 * is passed to handling modules which will attempt to determine
567 * the GECOS that bleongs to the given servername.
568 * @param servername The servername to find the description of
569 * @return The description of this server, or of the local server
571 std::string GetServerDescription(const char* servername);
573 /** Find a user in the nick hash.
574 * If the user cant be found in the nick hash check the uuid hash
575 * @param nick The nickname to find
576 * @return A pointer to the user, or NULL if the user does not exist
578 User* FindNick(const std::string &nick);
580 /** Find a user in the nick hash.
581 * If the user cant be found in the nick hash check the uuid hash
582 * @param nick The nickname to find
583 * @return A pointer to the user, or NULL if the user does not exist
585 User* FindNick(const char* nick);
587 /** Find a user in the nick hash ONLY
589 User* FindNickOnly(const char* nick);
591 /** Find a user in the nick hash ONLY
593 User* FindNickOnly(const std::string &nick);
595 /** Find a channel in the channels hash
596 * @param chan The channel to find
597 * @return A pointer to the channel, or NULL if the channel does not exist
599 Channel* FindChan(const std::string &chan);
601 /** Find a channel in the channels hash
602 * @param chan The channel to find
603 * @return A pointer to the channel, or NULL if the channel does not exist
605 Channel* FindChan(const char* chan);
607 /** Check for a 'die' tag in the config file, and abort if found
608 * @return Depending on the configuration, this function may never return
612 /** Check we aren't running as root, and exit if we are
613 * @return Depending on the configuration, this function may never return
617 /** Determine the right path for, and open, the logfile
618 * @param argv The argv passed to main() initially, used to calculate program path
619 * @param argc The argc passed to main() initially, used to calculate program path
620 * @return True if the log could be opened, false if otherwise
622 bool OpenLog(char** argv, int argc);
624 /** Return true if a channel name is valid
625 * @param chname A channel name to verify
626 * @return True if the name is valid
628 caller2<bool, const char*, size_t> IsChannel;
630 /** Return true if str looks like a server ID
631 * @param string to check against
633 caller1<bool, const std::string&> IsSID;
635 /** Rehash the local server
637 caller1<void, const std::string&> Rehash;
639 /** Handles incoming signals after being set
640 * @param signal the signal recieved
642 void SignalHandler(int signal);
644 /** Sets the signal recieved
645 * @param signal the signal recieved
647 static void SetSignal(int signal);
649 /** Causes the server to exit after unloading modules and
650 * closing all open file descriptors.
652 * @param The exit code to give to the operating system
653 * (See the ExitStatus enum for valid values)
655 void Exit(int status);
657 /** Causes the server to exit immediately with exit code 0.
658 * The status code is required for signal handlers, and ignored.
660 static void QuickExit(int status);
662 /** Return a count of channels on the network
663 * @return The number of channels
667 /** Send an error notice to all local users, opered and unopered
668 * @param s The error string to send
670 void SendError(const std::string &s);
672 /** Return true if a nickname is valid
673 * @param n A nickname to verify
674 * @return True if the nick is valid
676 caller2<bool, const char*, size_t> IsNick;
678 /** Return true if an ident is valid
679 * @param An ident to verify
680 * @return True if the ident is valid
682 caller1<bool, const char*> IsIdent;
684 /** Find a username by their file descriptor.
685 * It is preferred to use this over directly accessing the fd_ref_table array.
686 * @param socket The file descriptor of a user
687 * @return A pointer to the user if the user exists locally on this descriptor
689 caller1<User*, int> FindDescriptor;
691 /** Add a dns Resolver class to this server's active set
692 * @param r The resolver to add
693 * @param cached If this value is true, then the cache will
694 * be searched for the DNS result, immediately. If the value is
695 * false, then a request will be sent to the nameserver, and the
696 * result will not be immediately available. You should usually
697 * use the boolean value which you passed to the Resolver
698 * constructor, which Resolver will set appropriately depending
699 * on if cached results are available and haven't expired. It is
700 * however safe to force this value to false, forcing a remote DNS
701 * lookup, but not an update of the cache.
702 * @return True if the operation completed successfully. Note that
703 * if this method returns true, you should not attempt to access
704 * the resolver class you pass it after this call, as depending upon
705 * the request given, the object may be deleted!
707 bool AddResolver(Resolver* r, bool cached);
709 /** Add a command to this server's command parser
710 * @param f A Command command handler object to add
711 * @throw ModuleException Will throw ModuleExcption if the command already exists
713 void AddCommand(Command *f);
715 /** Send a modechange.
716 * The parameters provided are identical to that sent to the
717 * handler for class cmd_mode.
718 * @param parameters The mode parameters
719 * @param pcnt The number of items you have given in the first parameter
720 * @param user The user to send error messages to
722 void SendMode(const std::vector<std::string>& parameters, User *user);
724 /** Match two strings using pattern matching, optionally, with a map
725 * to check case against (may be NULL). If map is null, match will be case insensitive.
726 * @param str The literal string to match against
727 * @param mask The glob pattern to match against.
729 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
730 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
732 /** Match two strings using pattern matching, optionally, with a map
733 * to check case against (may be NULL). If map is null, match will be case insensitive.
734 * Supports CIDR patterns as well as globs.
735 * @param str The literal string to match against
736 * @param mask The glob or CIDR pattern to match against.
738 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
739 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
741 /** Call the handler for a given command.
742 * @param commandname The command whos handler you wish to call
743 * @param parameters The mode parameters
744 * @param pcnt The number of items you have given in the first parameter
745 * @param user The user to execute the command as
746 * @return True if the command handler was called successfully
748 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
750 /** Return true if the command is a module-implemented command and the given parameters are valid for it
751 * @param parameters The mode parameters
752 * @param pcnt The number of items you have given in the first parameter
753 * @param user The user to test-execute the command as
754 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
756 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
758 /** Return true if the given parameter is a valid nick!user\@host mask
759 * @param mask A nick!user\@host masak to match against
760 * @return True i the mask is valid
762 bool IsValidMask(const std::string &mask);
764 /** Rehash the local server
768 /** Return the channel whos index number matches that provided
769 * @param The index number of the channel to fetch
770 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
772 Channel* GetChannelIndex(long index);
774 /** Dump text to a user target, splitting it appropriately to fit
775 * @param User the user to dump the text to
776 * @param LinePrefix text to prefix each complete line with
777 * @param TextStream the text to send to the user
779 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
781 /** Check if the given nickmask matches too many users, send errors to the given user
782 * @param nick A nickmask to match against
783 * @param user A user to send error text to
784 * @return True if the nick matches too many users
786 bool NickMatchesEveryone(const std::string &nick, User* user);
788 /** Check if the given IP mask matches too many users, send errors to the given user
789 * @param ip An ipmask to match against
790 * @param user A user to send error text to
791 * @return True if the ip matches too many users
793 bool IPMatchesEveryone(const std::string &ip, User* user);
795 /** Check if the given hostmask matches too many users, send errors to the given user
796 * @param mask A hostmask to match against
797 * @param user A user to send error text to
798 * @return True if the host matches too many users
800 bool HostMatchesEveryone(const std::string &mask, User* user);
802 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
803 * @param str A string containing a time in the form 1y2w3d4h6m5s
804 * (one year, two weeks, three days, four hours, six minutes and five seconds)
805 * @return The total number of seconds
807 long Duration(const std::string &str);
809 /** Attempt to compare a password to a string from the config file.
810 * This will be passed to handling modules which will compare the data
811 * against possible hashed equivalents in the input string.
812 * @param ex The object (user, server, whatever) causing the comparison.
813 * @param data The data from the config file
814 * @param input The data input by the oper
815 * @param hashtype The hash from the config file
816 * @return 0 if the strings match, 1 or -1 if they do not
818 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
820 /** Check if a given server is a uline.
821 * An empty string returns true, this is by design.
822 * @param server The server to check for uline status
823 * @return True if the server is a uline OR the string is empty
825 bool ULine(const char* server);
827 /** Returns true if the uline is 'silent' (doesnt generate
828 * remote connect notices etc).
830 bool SilentULine(const char* server);
832 /** Returns the subversion revision ID of this ircd
833 * @return The revision ID or an empty string
835 std::string GetRevision();
837 /** Returns the full version string of this ircd
838 * @return The version string
840 std::string GetVersionString();
842 /** Attempt to write the process id to a given file
843 * @param filename The PID file to attempt to write to
844 * @return This function may bail if the file cannot be written
846 void WritePID(const std::string &filename);
848 /** This constructor initialises all the subsystems and reads the config file.
849 * @param argc The argument count passed to main()
850 * @param argv The argument list passed to main()
851 * @throw <anything> If anything is thrown from here and makes it to
852 * you, you should probably just give up and go home. Yes, really.
853 * It's that bad. Higher level classes should catch any non-fatal exceptions.
855 InspIRCd(int argc, char** argv);
857 /** Send a line of WHOIS data to a user.
858 * @param user user to send the line to
859 * @param dest user being WHOISed
860 * @param numeric Numeric to send
861 * @param text Text of the numeric
863 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
865 /** Send a line of WHOIS data to a user.
866 * @param user user to send the line to
867 * @param dest user being WHOISed
868 * @param numeric Numeric to send
869 * @param format Format string for the numeric
870 * @param ... Parameters for the format string
872 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
874 /** Quit a user for excess flood, and if they are not
875 * fully registered yet, temporarily zline their IP.
876 * @param current user to quit
878 caller1<void, User*> FloodQuitUser;
880 /** Restart the server.
881 * This function will not return. If an error occurs,
882 * it will throw an instance of CoreException.
883 * @param reason The restart reason to show to all clients
884 * @throw CoreException An instance of CoreException indicating the error from execv().
886 void Restart(const std::string &reason);
888 /** Prepare the ircd for restart or shutdown.
889 * This function unloads all modules which can be unloaded,
890 * closes all open sockets, and closes the logfile.
894 /** This copies the user and channel hash_maps into new hash maps.
895 * This frees memory used by the hash_map allocator (which it neglects
896 * to free, most of the time, using tons of ram)
898 void RehashUsersAndChans();
900 /** Resets the cached max bans value on all channels.
905 /** Return a time_t as a human-readable string.
907 std::string TimeString(time_t curtime);
909 /** Begin execution of the server.
910 * NOTE: this function NEVER returns. Internally,
911 * it will repeatedly loop.
912 * @return The return value for this function is undefined.
916 /** Force all BufferedSockets to be removed which are due to
919 void BufferedSocketCull();
921 /** Adds an extban char to the 005 token.
923 void AddExtBanChar(char c);
925 char* GetReadBuffer()
927 return this->ReadBuffer;