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;
69 #include "inspircd_config.h"
78 #include "usermanager.h"
81 #include "command_parse.h"
83 #include "socketengine.h"
85 #include "cull_list.h"
86 #include "filelogger.h"
89 #include "configreader.h"
90 #include "inspstring.h"
94 #warning Potentially broken system, PATH_MAX undefined
99 * Used to define the maximum number of parameters a command may have.
101 #define MAXPARAMETERS 127
103 /** Returned by some functions to indicate failure.
107 /** Support for librodent -
108 * see http://www.chatspike.net/index.php?z=64
110 #define ETIREDHAMSTERS EAGAIN
112 /** Template function to convert any input type to std::string
114 template<typename T> inline std::string ConvNumeric(const T &in)
116 if (in == 0) return "0";
121 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
128 std::reverse(res,out);
132 /** Template function to convert any input type to std::string
134 inline std::string ConvToStr(const int in)
136 return ConvNumeric(in);
139 /** Template function to convert any input type to std::string
141 inline std::string ConvToStr(const long in)
143 return ConvNumeric(in);
146 /** Template function to convert any input type to std::string
148 inline std::string ConvToStr(const char* in)
153 /** Template function to convert any input type to std::string
155 inline std::string ConvToStr(const bool in)
157 return (in ? "1" : "0");
160 /** Template function to convert any input type to std::string
162 inline std::string ConvToStr(char in)
164 return std::string(in,1);
167 /** Template function to convert any input type to std::string
169 template <class T> inline std::string ConvToStr(const T &in)
171 std::stringstream tmp;
172 if (!(tmp << in)) return std::string();
176 /** Template function to convert any input type to any other type
177 * (usually an integer or numeric type)
179 template<typename T> inline long ConvToInt(const T &in)
181 std::stringstream tmp;
182 if (!(tmp << in)) return 0;
183 return atoi(tmp.str().c_str());
186 /** Template function to convert integer to char, storing result in *res and
187 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
188 * @param T input value
189 * @param V result value
190 * @param R base to convert to
192 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
194 if (base < 2 || base > 16) { *res = 0; return res; }
198 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
202 if ( in < 0 && base == 10) *out++ = '-';
203 std::reverse( res, out );
208 /** This class contains various STATS counters
209 * It is used by the InspIRCd class, which internally
210 * has an instance of it.
212 class serverstats : public classbase
215 /** Number of accepted connections
217 unsigned long statsAccept;
218 /** Number of failed accepts
220 unsigned long statsRefused;
221 /** Number of unknown commands seen
223 unsigned long statsUnknown;
224 /** Number of nickname collisions handled
226 unsigned long statsCollisions;
227 /** Number of DNS queries sent out
229 unsigned long statsDns;
230 /** Number of good DNS replies received
231 * NOTE: This may not tally to the number sent out,
232 * due to timeouts and other latency issues.
234 unsigned long statsDnsGood;
235 /** Number of bad (negative) DNS replies received
236 * NOTE: This may not tally to the number sent out,
237 * due to timeouts and other latency issues.
239 unsigned long statsDnsBad;
240 /** Number of inbound connections seen
242 unsigned long statsConnects;
243 /** Total bytes of data transmitted
246 /** Total bytes of data received
249 /** Cpu usage at last sample
252 /** Time last sample was read
255 /** The constructor initializes all the counts to zero
258 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
259 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
266 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
267 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
268 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
269 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
270 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
271 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
272 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
273 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
275 /* Forward declaration - required */
277 class BanCacheManager;
279 /** The background thread for config reading, so that reading from executable includes
282 class CoreExport ConfigReaderThread : public Thread
284 InspIRCd* ServerInstance;
286 std::string TheUserUID;
288 ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid) : Thread(), ServerInstance(Instance), do_bail(bail), TheUserUID(useruid)
292 virtual ~ConfigReaderThread()
299 /** The main class of the irc server.
300 * This class contains instances of all the other classes
301 * in this software, with the exception of the base class,
302 * classbase. Amongst other things, it contains a ModeParser,
303 * a DNS object, a CommandParser object, and a list of active
304 * Module objects, and facilities for Module objects to
305 * interact with the core system it implements.
307 class CoreExport InspIRCd : public classbase
310 /** Holds the current UID. Used to generate the next one.
312 char current_uid[UUID_LENGTH];
314 /** Set up the signal handlers
318 /** Daemonize the ircd and close standard input/output streams
319 * @return True if the program daemonized succesfully
323 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
324 * @param TIME the current time
326 void DoSocketTimeouts(time_t TIME);
328 /** Increments the current UID by one.
330 void IncrementUID(int pos);
332 /** Perform background user events such as PING checks
334 void DoBackgroundUserStuff();
336 /** Returns true when all modules have done pre-registration checks on a user
337 * @param user The user to verify
338 * @return True if all modules have finished checking this user
340 bool AllModulesReportReady(User* user);
342 /** Logfile pathname specified on the commandline, or empty string
344 char LogFileName[MAXBUF];
346 /** The current time, updated in the mainloop
350 /** The time that was recorded last time around the mainloop
354 /** A 64k buffer used to read socket data into
355 * NOTE: update ValidateNetBufferSize if you change this
357 char ReadBuffer[65535];
359 /** Used when connecting clients
361 irc::sockets::insp_sockaddr client, server;
363 /** Used when connecting clients
373 /** Global cull list, will be processed on next iteration
375 CullList GlobalCulls;
379 ProcessUserHandler HandleProcessUser;
380 IsNickHandler HandleIsNick;
381 IsIdentHandler HandleIsIdent;
382 FindDescriptorHandler HandleFindDescriptor;
383 FloodQuitUserHandler HandleFloodQuitUser;
384 IsChannelHandler HandleIsChannel;
385 IsSIDHandler HandleIsSID;
386 RehashHandler HandleRehash;
388 /** BufferedSocket classes pending deletion after being closed.
389 * We don't delete these immediately as this may cause a segmentation fault.
391 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
393 Mutex* RehashFinishMutex;
395 /** 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
398 * SendMode expects a User* to send the numeric replies
399 * back to, so we create it a fake user that isnt in the user
400 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
401 * falls into the abyss :p
405 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
408 * This is provided as a pointer so that modules can change it to their custom mapping tables,
409 * e.g. for national character support.
411 unsigned const char *national_case_sensitive_map;
413 /** Returns the next available UID for this server.
415 std::string GetUID();
417 /** Find a user in the UUID hash
418 * @param nick The nickname to find
419 * @return A pointer to the user, or NULL if the user does not exist
421 User* FindUUID(const std::string &);
423 /** Find a user in the UUID hash
424 * @param nick The nickname to find
425 * @return A pointer to the user, or NULL if the user does not exist
427 User* FindUUID(const char *);
429 /** Build the ISUPPORT string by triggering all modules On005Numeric events
431 void BuildISupport();
433 /** List of server names we've seen.
435 servernamelist servernames;
437 /** Time this ircd was booted
441 /** Config file pathname specified on the commandline or via ./configure
443 char ConfigFileName[MAXBUF];
445 /** Mode handler, handles mode setting and removal
449 /** Command parser, handles client to server commands
451 CommandParser* Parser;
453 /** Socket engine, handles socket activity events
457 /** Thread engine, Handles threading where required
459 ThreadEngine* Threads;
461 /** Mutex engine, handles mutexes for threading where required
463 MutexFactory* Mutexes;
465 /** The thread/class used to read config files in REHASH and on startup
467 ConfigReaderThread* ConfigThread;
469 /** LogManager handles logging.
473 /** ModuleManager contains everything related to loading/unloading
476 ModuleManager* Modules;
478 /** BanCacheManager is used to speed up checking of restrictions on connection
481 BanCacheManager *BanCache;
483 /** Stats class, holds miscellaneous stats counters
487 /** Server Config class, holds configuration file data
489 ServerConfig* Config;
491 /** Snomask manager - handles routing of snomask messages
496 /** DNS class, provides resolver facilities to the core and modules
500 /** Timer manager class, triggers Timer timer events
502 TimerManager* Timers;
504 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
506 XLineManager* XLines;
508 /** User manager. Various methods and data associated with users.
512 /** Channel list, a hash_map containing all channels XXX move to channel manager class
516 /** Set to the current signal recieved
520 /** Protocol interface, overridden by server protocol modules
522 ProtocolInterface* PI;
524 /** Get the current time
525 * Because this only calls time() once every time around the mainloop,
526 * it is much faster than calling time() directly.
527 * @return The current time as an epoch value (time_t)
531 /** Process a user whos socket has been flagged as active
532 * @param cu The user to process
533 * @return There is no actual return value, however upon exit, the user 'cu' may have been
534 * marked for deletion in the global CullList.
536 caller1<void, User*> ProcessUser;
538 /** Bind all ports specified in the configuration file.
539 * @param bail True if the function should bail back to the shell on failure
540 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
541 * @return The number of ports actually bound without error
543 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
545 /** Binds a socket on an already open file descriptor
546 * @param sockfd A valid file descriptor of an open socket
547 * @param port The port number to bind to
548 * @param addr The address to bind to (IP only)
549 * @return True if the port was bound successfully
551 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
553 /** Adds a server name to the list of servers we've seen
554 * @param The servername to add
556 void AddServerName(const std::string &servername);
558 /** Finds a cached char* pointer of a server name,
559 * This is used to optimize User by storing only the pointer to the name
560 * @param The servername to find
561 * @return A pointer to this name, gauranteed to never become invalid
563 const char* FindServerNamePtr(const std::string &servername);
565 /** Returns true if we've seen the given server name before
566 * @param The servername to find
567 * @return True if we've seen this server name before
569 bool FindServerName(const std::string &servername);
571 /** Gets the GECOS (description) field of the given server.
572 * If the servername is not that of the local server, the name
573 * is passed to handling modules which will attempt to determine
574 * the GECOS that bleongs to the given servername.
575 * @param servername The servername to find the description of
576 * @return The description of this server, or of the local server
578 std::string GetServerDescription(const char* servername);
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 std::string &nick);
587 /** Find a user in the nick hash.
588 * If the user cant be found in the nick hash check the uuid hash
589 * @param nick The nickname to find
590 * @return A pointer to the user, or NULL if the user does not exist
592 User* FindNick(const char* nick);
594 /** Find a user in the nick hash ONLY
596 User* FindNickOnly(const char* nick);
598 /** Find a user in the nick hash ONLY
600 User* FindNickOnly(const std::string &nick);
602 /** Find a channel in the channels hash
603 * @param chan The channel to find
604 * @return A pointer to the channel, or NULL if the channel does not exist
606 Channel* FindChan(const std::string &chan);
608 /** Find a channel in the channels hash
609 * @param chan The channel to find
610 * @return A pointer to the channel, or NULL if the channel does not exist
612 Channel* FindChan(const char* chan);
614 /** Check for a 'die' tag in the config file, and abort if found
615 * @return Depending on the configuration, this function may never return
619 /** Check we aren't running as root, and exit if we are
620 * @return Depending on the configuration, this function may never return
624 /** Determine the right path for, and open, the logfile
625 * @param argv The argv passed to main() initially, used to calculate program path
626 * @param argc The argc passed to main() initially, used to calculate program path
627 * @return True if the log could be opened, false if otherwise
629 bool OpenLog(char** argv, int argc);
631 /** Return true if a channel name is valid
632 * @param chname A channel name to verify
633 * @return True if the name is valid
635 caller2<bool, const char*, size_t> IsChannel;
637 /** Return true if str looks like a server ID
638 * @param string to check against
640 caller1<bool, const std::string&> IsSID;
642 /** Rehash the local server
644 caller1<void, const std::string&> Rehash;
646 /** Handles incoming signals after being set
647 * @param signal the signal recieved
649 void SignalHandler(int signal);
651 /** Sets the signal recieved
652 * @param signal the signal recieved
654 static void SetSignal(int signal);
656 /** Causes the server to exit after unloading modules and
657 * closing all open file descriptors.
659 * @param The exit code to give to the operating system
660 * (See the ExitStatus enum for valid values)
662 void Exit(int status);
664 /** Causes the server to exit immediately with exit code 0.
665 * The status code is required for signal handlers, and ignored.
667 static void QuickExit(int status);
669 /** Return a count of channels on the network
670 * @return The number of channels
674 /** Send an error notice to all local users, opered and unopered
675 * @param s The error string to send
677 void SendError(const std::string &s);
679 /** Return true if a nickname is valid
680 * @param n A nickname to verify
681 * @return True if the nick is valid
683 caller2<bool, const char*, size_t> IsNick;
685 /** Return true if an ident is valid
686 * @param An ident to verify
687 * @return True if the ident is valid
689 caller1<bool, const char*> IsIdent;
691 /** Find a username by their file descriptor.
692 * It is preferred to use this over directly accessing the fd_ref_table array.
693 * @param socket The file descriptor of a user
694 * @return A pointer to the user if the user exists locally on this descriptor
696 caller1<User*, int> FindDescriptor;
698 /** Add a dns Resolver class to this server's active set
699 * @param r The resolver to add
700 * @param cached If this value is true, then the cache will
701 * be searched for the DNS result, immediately. If the value is
702 * false, then a request will be sent to the nameserver, and the
703 * result will not be immediately available. You should usually
704 * use the boolean value which you passed to the Resolver
705 * constructor, which Resolver will set appropriately depending
706 * on if cached results are available and haven't expired. It is
707 * however safe to force this value to false, forcing a remote DNS
708 * lookup, but not an update of the cache.
709 * @return True if the operation completed successfully. Note that
710 * if this method returns true, you should not attempt to access
711 * the resolver class you pass it after this call, as depending upon
712 * the request given, the object may be deleted!
714 bool AddResolver(Resolver* r, bool cached);
716 /** Add a command to this server's command parser
717 * @param f A Command command handler object to add
718 * @throw ModuleException Will throw ModuleExcption if the command already exists
720 void AddCommand(Command *f);
722 /** Send a modechange.
723 * The parameters provided are identical to that sent to the
724 * handler for class cmd_mode.
725 * @param parameters The mode parameters
726 * @param pcnt The number of items you have given in the first parameter
727 * @param user The user to send error messages to
729 void SendMode(const std::vector<std::string>& parameters, User *user);
731 /** Match two strings using pattern matching, optionally, with a map
732 * to check case against (may be NULL). If map is null, match will be case insensitive.
733 * @param str The literal string to match against
734 * @param mask The glob pattern to match against.
736 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
737 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
739 /** Match two strings using pattern matching, optionally, with a map
740 * to check case against (may be NULL). If map is null, match will be case insensitive.
741 * Supports CIDR patterns as well as globs.
742 * @param str The literal string to match against
743 * @param mask The glob or CIDR pattern to match against.
745 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
746 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
748 /** Call the handler for a given command.
749 * @param commandname The command whos handler you wish to call
750 * @param parameters The mode parameters
751 * @param pcnt The number of items you have given in the first parameter
752 * @param user The user to execute the command as
753 * @return True if the command handler was called successfully
755 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
757 /** Return true if the command is a module-implemented command and the given parameters are valid for it
758 * @param parameters The mode parameters
759 * @param pcnt The number of items you have given in the first parameter
760 * @param user The user to test-execute the command as
761 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
763 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
765 /** Return true if the given parameter is a valid nick!user\@host mask
766 * @param mask A nick!user\@host masak to match against
767 * @return True i the mask is valid
769 bool IsValidMask(const std::string &mask);
771 /** Rehash the local server
775 /** Return the channel whos index number matches that provided
776 * @param The index number of the channel to fetch
777 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
779 Channel* GetChannelIndex(long index);
781 /** Dump text to a user target, splitting it appropriately to fit
782 * @param User the user to dump the text to
783 * @param LinePrefix text to prefix each complete line with
784 * @param TextStream the text to send to the user
786 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
788 /** Check if the given nickmask matches too many users, send errors to the given user
789 * @param nick A nickmask to match against
790 * @param user A user to send error text to
791 * @return True if the nick matches too many users
793 bool NickMatchesEveryone(const std::string &nick, User* user);
795 /** Check if the given IP mask matches too many users, send errors to the given user
796 * @param ip An ipmask to match against
797 * @param user A user to send error text to
798 * @return True if the ip matches too many users
800 bool IPMatchesEveryone(const std::string &ip, User* user);
802 /** Check if the given hostmask matches too many users, send errors to the given user
803 * @param mask A hostmask to match against
804 * @param user A user to send error text to
805 * @return True if the host matches too many users
807 bool HostMatchesEveryone(const std::string &mask, User* user);
809 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
810 * @param str A string containing a time in the form 1y2w3d4h6m5s
811 * (one year, two weeks, three days, four hours, six minutes and five seconds)
812 * @return The total number of seconds
814 long Duration(const std::string &str);
816 /** Attempt to compare a password to a string from the config file.
817 * This will be passed to handling modules which will compare the data
818 * against possible hashed equivalents in the input string.
819 * @param ex The object (user, server, whatever) causing the comparison.
820 * @param data The data from the config file
821 * @param input The data input by the oper
822 * @param hashtype The hash from the config file
823 * @return 0 if the strings match, 1 or -1 if they do not
825 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
827 /** Check if a given server is a uline.
828 * An empty string returns true, this is by design.
829 * @param server The server to check for uline status
830 * @return True if the server is a uline OR the string is empty
832 bool ULine(const char* server);
834 /** Returns true if the uline is 'silent' (doesnt generate
835 * remote connect notices etc).
837 bool SilentULine(const char* server);
839 /** Returns the subversion revision ID of this ircd
840 * @return The revision ID or an empty string
842 std::string GetRevision();
844 /** Returns the full version string of this ircd
845 * @return The version string
847 std::string GetVersionString();
849 /** Attempt to write the process id to a given file
850 * @param filename The PID file to attempt to write to
851 * @return This function may bail if the file cannot be written
853 void WritePID(const std::string &filename);
855 /** This constructor initialises all the subsystems and reads the config file.
856 * @param argc The argument count passed to main()
857 * @param argv The argument list passed to main()
858 * @throw <anything> If anything is thrown from here and makes it to
859 * you, you should probably just give up and go home. Yes, really.
860 * It's that bad. Higher level classes should catch any non-fatal exceptions.
862 InspIRCd(int argc, char** argv);
864 /** Send a line of WHOIS data to a user.
865 * @param user user to send the line to
866 * @param dest user being WHOISed
867 * @param numeric Numeric to send
868 * @param text Text of the numeric
870 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
872 /** Send a line of WHOIS data to a user.
873 * @param user user to send the line to
874 * @param dest user being WHOISed
875 * @param numeric Numeric to send
876 * @param format Format string for the numeric
877 * @param ... Parameters for the format string
879 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
881 /** Quit a user for excess flood, and if they are not
882 * fully registered yet, temporarily zline their IP.
883 * @param current user to quit
885 caller1<void, User*> FloodQuitUser;
887 /** Restart the server.
888 * This function will not return. If an error occurs,
889 * it will throw an instance of CoreException.
890 * @param reason The restart reason to show to all clients
891 * @throw CoreException An instance of CoreException indicating the error from execv().
893 void Restart(const std::string &reason);
895 /** Prepare the ircd for restart or shutdown.
896 * This function unloads all modules which can be unloaded,
897 * closes all open sockets, and closes the logfile.
901 /** This copies the user and channel hash_maps into new hash maps.
902 * This frees memory used by the hash_map allocator (which it neglects
903 * to free, most of the time, using tons of ram)
905 void RehashUsersAndChans();
907 /** Resets the cached max bans value on all channels.
912 /** Return a time_t as a human-readable string.
914 std::string TimeString(time_t curtime);
916 /** Begin execution of the server.
917 * NOTE: this function NEVER returns. Internally,
918 * it will repeatedly loop.
919 * @return The return value for this function is undefined.
923 /** Force all BufferedSockets to be removed which are due to
926 void BufferedSocketCull();
928 /** Adds an extban char to the 005 token.
930 void AddExtBanChar(char c);
932 char* GetReadBuffer()
934 return this->ReadBuffer;