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.
50 /** A list of failed port bindings, used for informational purposes on startup */
51 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
53 /** A cached text file stored with its contents as lines
55 typedef std::deque< std::string > file_cache;
57 /** A configuration key and value pair
59 typedef std::pair< std::string, std::string > KeyVal;
61 /** A list of related configuration keys and values
63 typedef std::vector< KeyVal > KeyValList;
65 /** An entire config file, built up of KeyValLists
67 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 class CoreExport ConfigReaderThread : public Thread
282 InspIRCd* ServerInstance;
286 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
290 virtual ~ConfigReaderThread()
297 /** The main class of the irc server.
298 * This class contains instances of all the other classes
299 * in this software, with the exception of the base class,
300 * classbase. Amongst other things, it contains a ModeParser,
301 * a DNS object, a CommandParser object, and a list of active
302 * Module objects, and facilities for Module objects to
303 * interact with the core system it implements.
305 class CoreExport InspIRCd : public classbase
308 /** Holds the current UID. Used to generate the next one.
310 char current_uid[UUID_LENGTH];
312 /** Set up the signal handlers
316 /** Daemonize the ircd and close standard input/output streams
317 * @return True if the program daemonized succesfully
321 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
322 * @param TIME the current time
324 void DoSocketTimeouts(time_t TIME);
326 /** Increments the current UID by one.
328 void IncrementUID(int pos);
330 /** Perform background user events such as PING checks
332 void DoBackgroundUserStuff();
334 /** Returns true when all modules have done pre-registration checks on a user
335 * @param user The user to verify
336 * @return True if all modules have finished checking this user
338 bool AllModulesReportReady(User* user);
340 /** Logfile pathname specified on the commandline, or empty string
342 char LogFileName[MAXBUF];
344 /** The current time, updated in the mainloop
348 /** The time that was recorded last time around the mainloop
352 /** A 64k buffer used to read socket data into
353 * NOTE: update ValidateNetBufferSize if you change this
355 char ReadBuffer[65535];
357 /** Used when connecting clients
359 irc::sockets::insp_sockaddr client, server;
361 /** Used when connecting clients
371 /** Global cull list, will be processed on next iteration
373 CullList GlobalCulls;
377 ProcessUserHandler HandleProcessUser;
378 IsNickHandler HandleIsNick;
379 IsIdentHandler HandleIsIdent;
380 FindDescriptorHandler HandleFindDescriptor;
381 FloodQuitUserHandler HandleFloodQuitUser;
382 IsChannelHandler HandleIsChannel;
383 IsSIDHandler HandleIsSID;
384 RehashHandler HandleRehash;
386 /** BufferedSocket classes pending deletion after being closed.
387 * We don't delete these immediately as this may cause a segmentation fault.
389 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
391 /** 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
394 * SendMode expects a User* to send the numeric replies
395 * back to, so we create it a fake user that isnt in the user
396 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
397 * falls into the abyss :p
401 /** Returns the next available UID for this server.
403 std::string GetUID();
405 /** Find a user in the UUID hash
406 * @param nick The nickname to find
407 * @return A pointer to the user, or NULL if the user does not exist
409 User *FindUUID(const std::string &);
411 /** Find a user in the UUID hash
412 * @param nick The nickname to find
413 * @return A pointer to the user, or NULL if the user does not exist
415 User *FindUUID(const char *);
417 /** Build the ISUPPORT string by triggering all modules On005Numeric events
419 void BuildISupport();
421 /** List of server names we've seen.
423 servernamelist servernames;
425 /** Time this ircd was booted
429 /** Config file pathname specified on the commandline or via ./configure
431 char ConfigFileName[MAXBUF];
433 /** Mode handler, handles mode setting and removal
437 /** Command parser, handles client to server commands
439 CommandParser* Parser;
441 /** Socket engine, handles socket activity events
445 /** Thread engine, Handles threading where required
447 ThreadEngine* Threads;
449 /** Mutex engine, handles mutexes for threading where required
451 MutexFactory* Mutexes;
453 /** The thread/class used to read config files in REHASH and on startup
455 ConfigReaderThread* ConfigThread;
457 /** LogManager handles logging.
461 /** ModuleManager contains everything related to loading/unloading
464 ModuleManager* Modules;
466 /** BanCacheManager is used to speed up checking of restrictions on connection
469 BanCacheManager *BanCache;
471 /** Stats class, holds miscellaneous stats counters
475 /** Server Config class, holds configuration file data
477 ServerConfig* Config;
479 /** Snomask manager - handles routing of snomask messages
484 /** DNS class, provides resolver facilities to the core and modules
488 /** Timer manager class, triggers Timer timer events
490 TimerManager* Timers;
492 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
494 XLineManager* XLines;
496 /** User manager. Various methods and data associated with users.
500 /** Channel list, a hash_map containing all channels XXX move to channel manager class
504 /** Set to the current signal recieved
508 /** Protocol interface, overridden by server protocol modules
510 ProtocolInterface* PI;
512 /** Get the current time
513 * Because this only calls time() once every time around the mainloop,
514 * it is much faster than calling time() directly.
515 * @return The current time as an epoch value (time_t)
519 /** Process a user whos socket has been flagged as active
520 * @param cu The user to process
521 * @return There is no actual return value, however upon exit, the user 'cu' may have been
522 * marked for deletion in the global CullList.
524 caller1<void, User*> ProcessUser;
526 /** Bind all ports specified in the configuration file.
527 * @param bail True if the function should bail back to the shell on failure
528 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
529 * @return The number of ports actually bound without error
531 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
533 /** Binds a socket on an already open file descriptor
534 * @param sockfd A valid file descriptor of an open socket
535 * @param port The port number to bind to
536 * @param addr The address to bind to (IP only)
537 * @return True if the port was bound successfully
539 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
541 /** Adds a server name to the list of servers we've seen
542 * @param The servername to add
544 void AddServerName(const std::string &servername);
546 /** Finds a cached char* pointer of a server name,
547 * This is used to optimize User by storing only the pointer to the name
548 * @param The servername to find
549 * @return A pointer to this name, gauranteed to never become invalid
551 const char* FindServerNamePtr(const std::string &servername);
553 /** Returns true if we've seen the given server name before
554 * @param The servername to find
555 * @return True if we've seen this server name before
557 bool FindServerName(const std::string &servername);
559 /** Gets the GECOS (description) field of the given server.
560 * If the servername is not that of the local server, the name
561 * is passed to handling modules which will attempt to determine
562 * the GECOS that bleongs to the given servername.
563 * @param servername The servername to find the description of
564 * @return The description of this server, or of the local server
566 std::string GetServerDescription(const char* servername);
568 /** Find a user in the nick hash.
569 * If the user cant be found in the nick hash check the uuid hash
570 * @param nick The nickname to find
571 * @return A pointer to the user, or NULL if the user does not exist
573 User* FindNick(const std::string &nick);
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 char* nick);
582 /** Find a user in the nick hash ONLY
584 User* FindNickOnly(const char* nick);
586 /** Find a user in the nick hash ONLY
588 User* FindNickOnly(const std::string &nick);
590 /** Find a channel in the channels hash
591 * @param chan The channel to find
592 * @return A pointer to the channel, or NULL if the channel does not exist
594 Channel* FindChan(const std::string &chan);
596 /** Find a channel in the channels hash
597 * @param chan The channel to find
598 * @return A pointer to the channel, or NULL if the channel does not exist
600 Channel* FindChan(const char* chan);
602 /** Check for a 'die' tag in the config file, and abort if found
603 * @return Depending on the configuration, this function may never return
607 /** Check we aren't running as root, and exit if we are
608 * @return Depending on the configuration, this function may never return
612 /** Determine the right path for, and open, the logfile
613 * @param argv The argv passed to main() initially, used to calculate program path
614 * @param argc The argc passed to main() initially, used to calculate program path
615 * @return True if the log could be opened, false if otherwise
617 bool OpenLog(char** argv, int argc);
619 /** Return true if a channel name is valid
620 * @param chname A channel name to verify
621 * @return True if the name is valid
623 caller2<bool, const char*, size_t> IsChannel;
625 /** Return true if str looks like a server ID
626 * @param string to check against
628 caller1<bool, const std::string&> IsSID;
630 /** Rehash the local server
632 caller1<void, const std::string&> Rehash;
634 /** Handles incoming signals after being set
635 * @param signal the signal recieved
637 void SignalHandler(int signal);
639 /** Sets the signal recieved
640 * @param signal the signal recieved
642 static void SetSignal(int signal);
644 /** Causes the server to exit after unloading modules and
645 * closing all open file descriptors.
647 * @param The exit code to give to the operating system
648 * (See the ExitStatus enum for valid values)
650 void Exit(int status);
652 /** Causes the server to exit immediately with exit code 0.
653 * The status code is required for signal handlers, and ignored.
655 static void QuickExit(int status);
657 /** Return a count of channels on the network
658 * @return The number of channels
662 /** Send an error notice to all local users, opered and unopered
663 * @param s The error string to send
665 void SendError(const std::string &s);
667 /** Return true if a nickname is valid
668 * @param n A nickname to verify
669 * @return True if the nick is valid
671 caller2<bool, const char*, size_t> IsNick;
673 /** Return true if an ident is valid
674 * @param An ident to verify
675 * @return True if the ident is valid
677 caller1<bool, const char*> IsIdent;
679 /** Find a username by their file descriptor.
680 * It is preferred to use this over directly accessing the fd_ref_table array.
681 * @param socket The file descriptor of a user
682 * @return A pointer to the user if the user exists locally on this descriptor
684 caller1<User*, int> FindDescriptor;
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 pcnt The number of items you have given in the first parameter
715 * @param user The user to send error messages to
717 void SendMode(const std::vector<std::string>& parameters, User *user);
719 /** Match two strings using pattern matching, optionally, with a map
720 * to check case against (may be NULL). If map is null, match will be case insensitive.
721 * @param str The literal string to match against
722 * @param mask The glob pattern to match against.
724 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
725 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
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 * Supports CIDR patterns as well as globs.
730 * @param str The literal string to match against
731 * @param mask The glob or CIDR pattern to match against.
733 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
734 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
736 /** Call the handler for a given command.
737 * @param commandname The command whos handler you wish to call
738 * @param parameters The mode parameters
739 * @param pcnt The number of items you have given in the first parameter
740 * @param user The user to execute the command as
741 * @return True if the command handler was called successfully
743 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
745 /** Return true if the command is a module-implemented command and the given parameters are valid for it
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 test-execute the command as
749 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
751 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
753 /** Return true if the given parameter is a valid nick!user\@host mask
754 * @param mask A nick!user\@host masak to match against
755 * @return True i the mask is valid
757 bool IsValidMask(const std::string &mask);
759 /** Rehash the local server
763 /** Return the channel whos index number matches that provided
764 * @param The index number of the channel to fetch
765 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
767 Channel* GetChannelIndex(long index);
769 /** Dump text to a user target, splitting it appropriately to fit
770 * @param User the user to dump the text to
771 * @param LinePrefix text to prefix each complete line with
772 * @param TextStream the text to send to the user
774 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
776 /** Check if the given nickmask matches too many users, send errors to the given user
777 * @param nick A nickmask to match against
778 * @param user A user to send error text to
779 * @return True if the nick matches too many users
781 bool NickMatchesEveryone(const std::string &nick, User* user);
783 /** Check if the given IP mask matches too many users, send errors to the given user
784 * @param ip An ipmask to match against
785 * @param user A user to send error text to
786 * @return True if the ip matches too many users
788 bool IPMatchesEveryone(const std::string &ip, User* user);
790 /** Check if the given hostmask matches too many users, send errors to the given user
791 * @param mask A hostmask to match against
792 * @param user A user to send error text to
793 * @return True if the host matches too many users
795 bool HostMatchesEveryone(const std::string &mask, User* user);
797 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
798 * @param str A string containing a time in the form 1y2w3d4h6m5s
799 * (one year, two weeks, three days, four hours, six minutes and five seconds)
800 * @return The total number of seconds
802 long Duration(const std::string &str);
804 /** Attempt to compare a password to a string from the config file.
805 * This will be passed to handling modules which will compare the data
806 * against possible hashed equivalents in the input string.
807 * @param ex The object (user, server, whatever) causing the comparison.
808 * @param data The data from the config file
809 * @param input The data input by the oper
810 * @param hashtype The hash from the config file
811 * @return 0 if the strings match, 1 or -1 if they do not
813 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
815 /** Check if a given server is a uline.
816 * An empty string returns true, this is by design.
817 * @param server The server to check for uline status
818 * @return True if the server is a uline OR the string is empty
820 bool ULine(const char* server);
822 /** Returns true if the uline is 'silent' (doesnt generate
823 * remote connect notices etc).
825 bool SilentULine(const char* server);
827 /** Returns the subversion revision ID of this ircd
828 * @return The revision ID or an empty string
830 std::string GetRevision();
832 /** Returns the full version string of this ircd
833 * @return The version string
835 std::string GetVersionString();
837 /** Attempt to write the process id to a given file
838 * @param filename The PID file to attempt to write to
839 * @return This function may bail if the file cannot be written
841 void WritePID(const std::string &filename);
843 /** This constructor initialises all the subsystems and reads the config file.
844 * @param argc The argument count passed to main()
845 * @param argv The argument list passed to main()
846 * @throw <anything> If anything is thrown from here and makes it to
847 * you, you should probably just give up and go home. Yes, really.
848 * It's that bad. Higher level classes should catch any non-fatal exceptions.
850 InspIRCd(int argc, char** argv);
852 /** Send a line of WHOIS data to a user.
853 * @param user user to send the line to
854 * @param dest user being WHOISed
855 * @param numeric Numeric to send
856 * @param text Text of the numeric
858 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
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 format Format string for the numeric
865 * @param ... Parameters for the format string
867 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
869 /** Quit a user for excess flood, and if they are not
870 * fully registered yet, temporarily zline their IP.
871 * @param current user to quit
873 caller1<void, User*> FloodQuitUser;
875 /** Restart the server.
876 * This function will not return. If an error occurs,
877 * it will throw an instance of CoreException.
878 * @param reason The restart reason to show to all clients
879 * @throw CoreException An instance of CoreException indicating the error from execv().
881 void Restart(const std::string &reason);
883 /** Prepare the ircd for restart or shutdown.
884 * This function unloads all modules which can be unloaded,
885 * closes all open sockets, and closes the logfile.
889 /** This copies the user and channel hash_maps into new hash maps.
890 * This frees memory used by the hash_map allocator (which it neglects
891 * to free, most of the time, using tons of ram)
893 void RehashUsersAndChans();
895 /** Resets the cached max bans value on all channels.
900 /** Return a time_t as a human-readable string.
902 std::string TimeString(time_t curtime);
904 /** Begin execution of the server.
905 * NOTE: this function NEVER returns. Internally,
906 * it will repeatedly loop.
907 * @return The return value for this function is undefined.
911 /** Force all BufferedSockets to be removed which are due to
914 void BufferedSocketCull();
916 /** Adds an extban char to the 005 token.
918 void AddExtBanChar(char c);
920 char* GetReadBuffer()
922 return this->ReadBuffer;