1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 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__
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.
56 /** A list of failed port bindings, used for informational purposes on startup */
57 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
59 /** A cached text file stored with its contents as lines
61 typedef std::deque< std::string > file_cache;
63 /** A configuration key and value pair
65 typedef std::pair< std::string, std::string > KeyVal;
67 /** A list of related configuration keys and values
69 typedef std::vector< KeyVal > KeyValList;
71 /** An entire config file, built up of KeyValLists
73 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
75 #include "inspircd_config.h"
84 #include "usermanager.h"
87 #include "command_parse.h"
89 #include "socketengine.h"
91 #include "cull_list.h"
92 #include "filelogger.h"
95 #include "configreader.h"
96 #include "inspstring.h"
100 #warning Potentially broken system, PATH_MAX undefined
101 #define PATH_MAX 4096
105 * Used to define the maximum number of parameters a command may have.
107 #define MAXPARAMETERS 127
109 /** Returned by some functions to indicate failure.
113 /** Support for librodent -
114 * see http://www.chatspike.net/index.php?z=64
116 #define ETIREDHAMSTERS EAGAIN
118 /** Template function to convert any input type to std::string
120 template<typename T> inline std::string ConvNumeric(const T &in)
122 if (in == 0) return "0";
127 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
134 std::reverse(res,out);
138 /** Template function to convert any input type to std::string
140 inline std::string ConvToStr(const int in)
142 return ConvNumeric(in);
145 /** Template function to convert any input type to std::string
147 inline std::string ConvToStr(const long in)
149 return ConvNumeric(in);
152 /** Template function to convert any input type to std::string
154 inline std::string ConvToStr(const char* in)
159 /** Template function to convert any input type to std::string
161 inline std::string ConvToStr(const bool in)
163 return (in ? "1" : "0");
166 /** Template function to convert any input type to std::string
168 inline std::string ConvToStr(char in)
170 return std::string(in,1);
173 /** Template function to convert any input type to std::string
175 template <class T> inline std::string ConvToStr(const T &in)
177 std::stringstream tmp;
178 if (!(tmp << in)) return std::string();
182 /** Template function to convert any input type to any other type
183 * (usually an integer or numeric type)
185 template<typename T> inline long ConvToInt(const T &in)
187 std::stringstream tmp;
188 if (!(tmp << in)) return 0;
189 return atoi(tmp.str().c_str());
192 /** Template function to convert integer to char, storing result in *res and
193 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
194 * @param T input value
195 * @param V result value
196 * @param R base to convert to
198 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
200 if (base < 2 || base > 16) { *res = 0; return res; }
204 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
208 if ( in < 0 && base == 10) *out++ = '-';
209 std::reverse( res, out );
214 /** This class contains various STATS counters
215 * It is used by the InspIRCd class, which internally
216 * has an instance of it.
218 class serverstats : public classbase
221 /** Number of accepted connections
223 unsigned long statsAccept;
224 /** Number of failed accepts
226 unsigned long statsRefused;
227 /** Number of unknown commands seen
229 unsigned long statsUnknown;
230 /** Number of nickname collisions handled
232 unsigned long statsCollisions;
233 /** Number of DNS queries sent out
235 unsigned long statsDns;
236 /** Number of good 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 statsDnsGood;
241 /** Number of bad (negative) DNS replies received
242 * NOTE: This may not tally to the number sent out,
243 * due to timeouts and other latency issues.
245 unsigned long statsDnsBad;
246 /** Number of inbound connections seen
248 unsigned long statsConnects;
249 /** Total bytes of data transmitted
252 /** Total bytes of data received
255 /** Cpu usage at last sample
258 /** Time last sample was read
261 /** The constructor initializes all the counts to zero
264 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
265 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
272 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
273 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
274 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
275 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
276 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
277 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
278 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
279 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
281 /* Forward declaration - required */
283 class BanCacheManager;
285 /** The background thread for config reading, so that reading from executable includes
288 class CoreExport ConfigReaderThread : public Thread
290 InspIRCd* ServerInstance;
292 std::string TheUserUID;
294 ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid) : Thread(), ServerInstance(Instance), do_bail(bail), TheUserUID(useruid)
298 virtual ~ConfigReaderThread()
305 /** The main class of the irc server.
306 * This class contains instances of all the other classes
307 * in this software, with the exception of the base class,
308 * classbase. Amongst other things, it contains a ModeParser,
309 * a DNS object, a CommandParser object, and a list of active
310 * Module objects, and facilities for Module objects to
311 * interact with the core system it implements.
313 class CoreExport InspIRCd : public classbase
316 /** Holds the current UID. Used to generate the next one.
318 char current_uid[UUID_LENGTH];
320 /** Set up the signal handlers
324 /** Daemonize the ircd and close standard input/output streams
325 * @return True if the program daemonized succesfully
329 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
330 * @param TIME the current time
332 void DoSocketTimeouts(time_t TIME);
334 /** Increments the current UID by one.
336 void IncrementUID(int pos);
338 /** Perform background user events such as PING checks
340 void DoBackgroundUserStuff();
342 /** Returns true when all modules have done pre-registration checks on a user
343 * @param user The user to verify
344 * @return True if all modules have finished checking this user
346 bool AllModulesReportReady(User* user);
348 /** Logfile pathname specified on the commandline, or empty string
350 char LogFileName[MAXBUF];
352 /** The current time, updated in the mainloop
356 /** The time that was recorded last time around the mainloop
360 /** A 64k buffer used to read socket data into
361 * NOTE: update ValidateNetBufferSize if you change this
363 char ReadBuffer[65535];
365 /** Used when connecting clients
367 irc::sockets::insp_sockaddr client, server;
369 /** Used when connecting clients
379 /** Global cull list, will be processed on next iteration
381 CullList GlobalCulls;
385 ProcessUserHandler HandleProcessUser;
386 IsNickHandler HandleIsNick;
387 IsIdentHandler HandleIsIdent;
388 FindDescriptorHandler HandleFindDescriptor;
389 FloodQuitUserHandler HandleFloodQuitUser;
390 IsChannelHandler HandleIsChannel;
391 IsSIDHandler HandleIsSID;
392 RehashHandler HandleRehash;
394 /** BufferedSocket classes pending deletion after being closed.
395 * We don't delete these immediately as this may cause a segmentation fault.
397 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
399 Mutex* RehashFinishMutex;
401 /** 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
404 * SendMode expects a User* to send the numeric replies
405 * back to, so we create it a fake user that isnt in the user
406 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
407 * falls into the abyss :p
411 /** Returns the next available UID for this server.
413 std::string GetUID();
415 /** Find a user in the UUID hash
416 * @param nick The nickname to find
417 * @return A pointer to the user, or NULL if the user does not exist
419 User* FindUUID(const std::string &);
421 /** Find a user in the UUID hash
422 * @param nick The nickname to find
423 * @return A pointer to the user, or NULL if the user does not exist
425 User* FindUUID(const char *);
427 /** Build the ISUPPORT string by triggering all modules On005Numeric events
429 void BuildISupport();
431 /** List of server names we've seen.
433 servernamelist servernames;
435 /** Time this ircd was booted
439 /** Config file pathname specified on the commandline or via ./configure
441 char ConfigFileName[MAXBUF];
443 /** Mode handler, handles mode setting and removal
447 /** Command parser, handles client to server commands
449 CommandParser* Parser;
451 /** Socket engine, handles socket activity events
455 /** Thread engine, Handles threading where required
457 ThreadEngine* Threads;
459 /** Mutex engine, handles mutexes for threading where required
461 MutexFactory* Mutexes;
463 /** The thread/class used to read config files in REHASH and on startup
465 ConfigReaderThread* ConfigThread;
467 /** LogManager handles logging.
471 /** ModuleManager contains everything related to loading/unloading
474 ModuleManager* Modules;
476 /** BanCacheManager is used to speed up checking of restrictions on connection
479 BanCacheManager *BanCache;
481 /** Stats class, holds miscellaneous stats counters
485 /** Server Config class, holds configuration file data
487 ServerConfig* Config;
489 /** Snomask manager - handles routing of snomask messages
494 /** DNS class, provides resolver facilities to the core and modules
498 /** Timer manager class, triggers Timer timer events
500 TimerManager* Timers;
502 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
504 XLineManager* XLines;
506 /** User manager. Various methods and data associated with users.
510 /** Channel list, a hash_map containing all channels XXX move to channel manager class
514 /** Set to the current signal recieved
518 /** Protocol interface, overridden by server protocol modules
520 ProtocolInterface* PI;
522 /** Get the current time
523 * Because this only calls time() once every time around the mainloop,
524 * it is much faster than calling time() directly.
525 * @return The current time as an epoch value (time_t)
529 /** Process a user whos socket has been flagged as active
530 * @param cu The user to process
531 * @return There is no actual return value, however upon exit, the user 'cu' may have been
532 * marked for deletion in the global CullList.
534 caller1<void, User*> ProcessUser;
536 /** Bind all ports specified in the configuration file.
537 * @param bail True if the function should bail back to the shell on failure
538 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
539 * @return The number of ports actually bound without error
541 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
543 /** Binds a socket on an already open file descriptor
544 * @param sockfd A valid file descriptor of an open socket
545 * @param port The port number to bind to
546 * @param addr The address to bind to (IP only)
547 * @return True if the port was bound successfully
549 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
551 /** Adds a server name to the list of servers we've seen
552 * @param The servername to add
554 void AddServerName(const std::string &servername);
556 /** Finds a cached char* pointer of a server name,
557 * This is used to optimize User by storing only the pointer to the name
558 * @param The servername to find
559 * @return A pointer to this name, gauranteed to never become invalid
561 const char* FindServerNamePtr(const std::string &servername);
563 /** Returns true if we've seen the given server name before
564 * @param The servername to find
565 * @return True if we've seen this server name before
567 bool FindServerName(const std::string &servername);
569 /** Gets the GECOS (description) field of the given server.
570 * If the servername is not that of the local server, the name
571 * is passed to handling modules which will attempt to determine
572 * the GECOS that bleongs to the given servername.
573 * @param servername The servername to find the description of
574 * @return The description of this server, or of the local server
576 std::string GetServerDescription(const char* servername);
578 /** Find a user in the nick hash.
579 * If the user cant be found in the nick hash check the uuid hash
580 * @param nick The nickname to find
581 * @return A pointer to the user, or NULL if the user does not exist
583 User* FindNick(const std::string &nick);
585 /** Find a user in the nick hash.
586 * If the user cant be found in the nick hash check the uuid hash
587 * @param nick The nickname to find
588 * @return A pointer to the user, or NULL if the user does not exist
590 User* FindNick(const char* nick);
592 /** Find a user in the nick hash ONLY
594 User* FindNickOnly(const char* nick);
596 /** Find a user in the nick hash ONLY
598 User* FindNickOnly(const std::string &nick);
600 /** Find a channel in the channels hash
601 * @param chan The channel to find
602 * @return A pointer to the channel, or NULL if the channel does not exist
604 Channel* FindChan(const std::string &chan);
606 /** Find a channel in the channels hash
607 * @param chan The channel to find
608 * @return A pointer to the channel, or NULL if the channel does not exist
610 Channel* FindChan(const char* chan);
612 /** Check for a 'die' tag in the config file, and abort if found
613 * @return Depending on the configuration, this function may never return
617 /** Check we aren't running as root, and exit if we are
618 * @return Depending on the configuration, this function may never return
622 /** Determine the right path for, and open, the logfile
623 * @param argv The argv passed to main() initially, used to calculate program path
624 * @param argc The argc passed to main() initially, used to calculate program path
625 * @return True if the log could be opened, false if otherwise
627 bool OpenLog(char** argv, int argc);
629 /** Return true if a channel name is valid
630 * @param chname A channel name to verify
631 * @return True if the name is valid
633 caller2<bool, const char*, size_t> IsChannel;
635 /** Return true if str looks like a server ID
636 * @param string to check against
638 caller1<bool, const std::string&> IsSID;
640 /** Rehash the local server
642 caller1<void, const std::string&> Rehash;
644 /** Handles incoming signals after being set
645 * @param signal the signal recieved
647 void SignalHandler(int signal);
649 /** Sets the signal recieved
650 * @param signal the signal recieved
652 static void SetSignal(int signal);
654 /** Causes the server to exit after unloading modules and
655 * closing all open file descriptors.
657 * @param The exit code to give to the operating system
658 * (See the ExitStatus enum for valid values)
660 void Exit(int status);
662 /** Causes the server to exit immediately with exit code 0.
663 * The status code is required for signal handlers, and ignored.
665 static void QuickExit(int status);
667 /** Return a count of channels on the network
668 * @return The number of channels
672 /** Send an error notice to all local users, opered and unopered
673 * @param s The error string to send
675 void SendError(const std::string &s);
677 /** Return true if a nickname is valid
678 * @param n A nickname to verify
679 * @return True if the nick is valid
681 caller2<bool, const char*, size_t> IsNick;
683 /** Return true if an ident is valid
684 * @param An ident to verify
685 * @return True if the ident is valid
687 caller1<bool, const char*> IsIdent;
689 /** Find a username by their file descriptor.
690 * It is preferred to use this over directly accessing the fd_ref_table array.
691 * @param socket The file descriptor of a user
692 * @return A pointer to the user if the user exists locally on this descriptor
694 caller1<User*, int> FindDescriptor;
696 /** Add a dns Resolver class to this server's active set
697 * @param r The resolver to add
698 * @param cached If this value is true, then the cache will
699 * be searched for the DNS result, immediately. If the value is
700 * false, then a request will be sent to the nameserver, and the
701 * result will not be immediately available. You should usually
702 * use the boolean value which you passed to the Resolver
703 * constructor, which Resolver will set appropriately depending
704 * on if cached results are available and haven't expired. It is
705 * however safe to force this value to false, forcing a remote DNS
706 * lookup, but not an update of the cache.
707 * @return True if the operation completed successfully. Note that
708 * if this method returns true, you should not attempt to access
709 * the resolver class you pass it after this call, as depending upon
710 * the request given, the object may be deleted!
712 bool AddResolver(Resolver* r, bool cached);
714 /** Add a command to this server's command parser
715 * @param f A Command command handler object to add
716 * @throw ModuleException Will throw ModuleExcption if the command already exists
718 void AddCommand(Command *f);
720 /** Send a modechange.
721 * The parameters provided are identical to that sent to the
722 * handler for class cmd_mode.
723 * @param parameters The mode parameters
724 * @param pcnt The number of items you have given in the first parameter
725 * @param user The user to send error messages to
727 void SendMode(const std::vector<std::string>& parameters, User *user);
729 /** Match two strings using pattern matching, optionally, with a map
730 * to check case against (may be NULL). If map is null, match will be case insensitive.
731 * @param str The literal string to match against
732 * @param mask The glob pattern to match against.
734 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
735 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
737 /** Match two strings using pattern matching, optionally, with a map
738 * to check case against (may be NULL). If map is null, match will be case insensitive.
739 * Supports CIDR patterns as well as globs.
740 * @param str The literal string to match against
741 * @param mask The glob or CIDR pattern to match against.
743 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
744 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
746 /** Call the handler for a given command.
747 * @param commandname The command whos handler you wish to call
748 * @param parameters The mode parameters
749 * @param pcnt The number of items you have given in the first parameter
750 * @param user The user to execute the command as
751 * @return True if the command handler was called successfully
753 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
755 /** Return true if the command is a module-implemented command and the given parameters are valid for it
756 * @param parameters The mode parameters
757 * @param pcnt The number of items you have given in the first parameter
758 * @param user The user to test-execute the command as
759 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
761 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
763 /** Return true if the given parameter is a valid nick!user\@host mask
764 * @param mask A nick!user\@host masak to match against
765 * @return True i the mask is valid
767 bool IsValidMask(const std::string &mask);
769 /** Rehash the local server
773 /** Return the channel whos index number matches that provided
774 * @param The index number of the channel to fetch
775 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
777 Channel* GetChannelIndex(long index);
779 /** Dump text to a user target, splitting it appropriately to fit
780 * @param User the user to dump the text to
781 * @param LinePrefix text to prefix each complete line with
782 * @param TextStream the text to send to the user
784 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
786 /** Check if the given nickmask matches too many users, send errors to the given user
787 * @param nick A nickmask to match against
788 * @param user A user to send error text to
789 * @return True if the nick matches too many users
791 bool NickMatchesEveryone(const std::string &nick, User* user);
793 /** Check if the given IP mask matches too many users, send errors to the given user
794 * @param ip An ipmask to match against
795 * @param user A user to send error text to
796 * @return True if the ip matches too many users
798 bool IPMatchesEveryone(const std::string &ip, User* user);
800 /** Check if the given hostmask matches too many users, send errors to the given user
801 * @param mask A hostmask to match against
802 * @param user A user to send error text to
803 * @return True if the host matches too many users
805 bool HostMatchesEveryone(const std::string &mask, User* user);
807 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
808 * @param str A string containing a time in the form 1y2w3d4h6m5s
809 * (one year, two weeks, three days, four hours, six minutes and five seconds)
810 * @return The total number of seconds
812 long Duration(const std::string &str);
814 /** Attempt to compare a password to a string from the config file.
815 * This will be passed to handling modules which will compare the data
816 * against possible hashed equivalents in the input string.
817 * @param ex The object (user, server, whatever) causing the comparison.
818 * @param data The data from the config file
819 * @param input The data input by the oper
820 * @param hashtype The hash from the config file
821 * @return 0 if the strings match, 1 or -1 if they do not
823 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
825 /** Check if a given server is a uline.
826 * An empty string returns true, this is by design.
827 * @param server The server to check for uline status
828 * @return True if the server is a uline OR the string is empty
830 bool ULine(const char* server);
832 /** Returns true if the uline is 'silent' (doesnt generate
833 * remote connect notices etc).
835 bool SilentULine(const char* server);
837 /** Returns the subversion revision ID of this ircd
838 * @return The revision ID or an empty string
840 std::string GetRevision();
842 /** Returns the full version string of this ircd
843 * @return The version string
845 std::string GetVersionString();
847 /** Attempt to write the process id to a given file
848 * @param filename The PID file to attempt to write to
849 * @return This function may bail if the file cannot be written
851 void WritePID(const std::string &filename);
853 /** This constructor initialises all the subsystems and reads the config file.
854 * @param argc The argument count passed to main()
855 * @param argv The argument list passed to main()
856 * @throw <anything> If anything is thrown from here and makes it to
857 * you, you should probably just give up and go home. Yes, really.
858 * It's that bad. Higher level classes should catch any non-fatal exceptions.
860 InspIRCd(int argc, char** argv);
862 /** Send a line of WHOIS data to a user.
863 * @param user user to send the line to
864 * @param dest user being WHOISed
865 * @param numeric Numeric to send
866 * @param text Text of the numeric
868 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
870 /** Send a line of WHOIS data to a user.
871 * @param user user to send the line to
872 * @param dest user being WHOISed
873 * @param numeric Numeric to send
874 * @param format Format string for the numeric
875 * @param ... Parameters for the format string
877 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
879 /** Quit a user for excess flood, and if they are not
880 * fully registered yet, temporarily zline their IP.
881 * @param current user to quit
883 caller1<void, User*> FloodQuitUser;
885 /** Restart the server.
886 * This function will not return. If an error occurs,
887 * it will throw an instance of CoreException.
888 * @param reason The restart reason to show to all clients
889 * @throw CoreException An instance of CoreException indicating the error from execv().
891 void Restart(const std::string &reason);
893 /** Prepare the ircd for restart or shutdown.
894 * This function unloads all modules which can be unloaded,
895 * closes all open sockets, and closes the logfile.
899 /** This copies the user and channel hash_maps into new hash maps.
900 * This frees memory used by the hash_map allocator (which it neglects
901 * to free, most of the time, using tons of ram)
903 void RehashUsersAndChans();
905 /** Resets the cached max bans value on all channels.
910 /** Return a time_t as a human-readable string.
912 std::string TimeString(time_t curtime);
914 /** Begin execution of the server.
915 * NOTE: this function NEVER returns. Internally,
916 * it will repeatedly loop.
917 * @return The return value for this function is undefined.
921 /** Force all BufferedSockets to be removed which are due to
924 void BufferedSocketCull();
926 /** Adds an extban char to the 005 token.
928 void AddExtBanChar(char c);
930 char* GetReadBuffer()
932 return this->ReadBuffer;