1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __INSPIRCD_H__
15 #define __INSPIRCD_H__
17 #define _FILE_OFFSET_BITS 64
18 #ifndef _LARGEFILE_SOURCE
19 #define _LARGEFILE_SOURCE
25 #define printf_c printf
27 #include "inspircd_win32wrapper.h"
28 /** Windows defines these already */
34 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
36 #define CUSTOM_PRINTF(STRING, FIRST)
39 // Required system headers.
57 /** A list of failed port bindings, used for informational purposes on startup */
58 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
60 /** A cached text file stored with its contents as lines
62 typedef std::deque< std::string > file_cache;
64 /** A configuration key and value pair
66 typedef std::pair< std::string, std::string > KeyVal;
68 /** A list of related configuration keys and values
70 typedef std::vector< KeyVal > KeyValList;
72 /** An entire config file, built up of KeyValLists
74 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
76 #include "inspircd_config.h"
85 #include "usermanager.h"
88 #include "command_parse.h"
90 #include "socketengine.h"
92 #include "cull_list.h"
93 #include "filelogger.h"
96 #include "configreader.h"
97 #include "inspstring.h"
99 #include "threadengine.h"
100 #include "fakeuser.h"
103 #warning Potentially broken system, PATH_MAX undefined
104 #define PATH_MAX 4096
108 * Used to define the maximum number of parameters a command may have.
110 #define MAXPARAMETERS 127
112 /** Returned by some functions to indicate failure.
116 /** Support for librodent -
117 * see http://www.chatspike.net/index.php?z=64
119 #define ETIREDHAMSTERS EAGAIN
121 /** Template function to convert any input type to std::string
123 template<typename T> inline std::string ConvNumeric(const T &in)
125 if (in == 0) return "0";
130 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
137 std::reverse(res,out);
141 /** Template function to convert any input type to std::string
143 inline std::string ConvToStr(const int in)
145 return ConvNumeric(in);
148 /** Template function to convert any input type to std::string
150 inline std::string ConvToStr(const long in)
152 return ConvNumeric(in);
155 /** Template function to convert any input type to std::string
157 inline std::string ConvToStr(const char* in)
162 /** Template function to convert any input type to std::string
164 inline std::string ConvToStr(const bool in)
166 return (in ? "1" : "0");
169 /** Template function to convert any input type to std::string
171 inline std::string ConvToStr(char in)
173 return std::string(in,1);
176 /** Template function to convert any input type to std::string
178 template <class T> inline std::string ConvToStr(const T &in)
180 std::stringstream tmp;
181 if (!(tmp << in)) return std::string();
185 /** Template function to convert any input type to any other type
186 * (usually an integer or numeric type)
188 template<typename T> inline long ConvToInt(const T &in)
190 std::stringstream tmp;
191 if (!(tmp << in)) return 0;
192 return atoi(tmp.str().c_str());
195 /** Template function to convert integer to char, storing result in *res and
196 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
197 * @param T input value
198 * @param V result value
199 * @param R base to convert to
201 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
203 if (base < 2 || base > 16) { *res = 0; return res; }
207 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
211 if ( in < 0 && base == 10) *out++ = '-';
212 std::reverse( res, out );
217 /** This class contains various STATS counters
218 * It is used by the InspIRCd class, which internally
219 * has an instance of it.
221 class serverstats : public classbase
224 /** Number of accepted connections
226 unsigned long statsAccept;
227 /** Number of failed accepts
229 unsigned long statsRefused;
230 /** Number of unknown commands seen
232 unsigned long statsUnknown;
233 /** Number of nickname collisions handled
235 unsigned long statsCollisions;
236 /** Number of DNS queries sent out
238 unsigned long statsDns;
239 /** Number of good DNS replies received
240 * NOTE: This may not tally to the number sent out,
241 * due to timeouts and other latency issues.
243 unsigned long statsDnsGood;
244 /** Number of bad (negative) DNS replies received
245 * NOTE: This may not tally to the number sent out,
246 * due to timeouts and other latency issues.
248 unsigned long statsDnsBad;
249 /** Number of inbound connections seen
251 unsigned long statsConnects;
252 /** Total bytes of data transmitted
255 /** Total bytes of data received
258 /** Cpu usage at last sample
261 /** Time last sample was read
264 /** The constructor initializes all the counts to zero
267 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
268 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
275 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
276 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
277 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
278 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
279 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
280 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
281 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
283 /* Forward declaration - required */
285 class BanCacheManager;
287 /** The background thread for config reading, so that reading from executable includes
290 class CoreExport ConfigReaderThread : public Thread
292 InspIRCd* ServerInstance;
293 ServerConfig* Config;
296 std::string TheUserUID;
297 ConfigReaderThread(InspIRCd* Instance, const std::string &useruid)
298 : Thread(), ServerInstance(Instance), done(false), TheUserUID(useruid)
302 virtual ~ConfigReaderThread()
307 /** Run in the main thread to apply the configuration */
309 bool IsDone() { return done; }
312 /** The main class of the irc server.
313 * This class contains instances of all the other classes
314 * in this software, with the exception of the base class,
315 * classbase. Amongst other things, it contains a ModeParser,
316 * a DNS object, a CommandParser object, and a list of active
317 * Module objects, and facilities for Module objects to
318 * interact with the core system it implements.
320 class CoreExport InspIRCd : public classbase
323 /** Holds the current UID. Used to generate the next one.
325 char current_uid[UUID_LENGTH];
327 /** Set up the signal handlers
331 /** Daemonize the ircd and close standard input/output streams
332 * @return True if the program daemonized succesfully
336 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
337 * @param TIME the current time
339 void DoSocketTimeouts(time_t TIME);
341 /** Increments the current UID by one.
343 void IncrementUID(int pos);
345 /** Perform background user events such as PING checks
347 void DoBackgroundUserStuff();
349 /** Returns true when all modules have done pre-registration checks on a user
350 * @param user The user to verify
351 * @return True if all modules have finished checking this user
353 bool AllModulesReportReady(User* user);
355 /** Logfile pathname specified on the commandline, or empty string
357 char LogFileName[MAXBUF];
359 /** The current time, updated in the mainloop
363 /** The time that was recorded last time around the mainloop
367 /** A 64k buffer used to read socket data into
368 * NOTE: update ValidateNetBufferSize if you change this
370 char ReadBuffer[65535];
378 /** Global cull list, will be processed on next iteration
380 CullList GlobalCulls;
384 ProcessUserHandler HandleProcessUser;
385 IsNickHandler HandleIsNick;
386 IsIdentHandler HandleIsIdent;
387 FloodQuitUserHandler HandleFloodQuitUser;
388 IsChannelHandler HandleIsChannel;
389 IsSIDHandler HandleIsSID;
390 RehashHandler HandleRehash;
392 /** BufferedSocket classes pending deletion after being closed.
393 * We don't delete these immediately as this may cause a segmentation fault.
395 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
397 /** 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
400 * SendMode expects a User* to send the numeric replies
401 * back to, so we create it a fake user that isnt in the user
402 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
403 * falls into the abyss :p
405 FakeUser* FakeClient;
407 /** Returns the next available UID for this server.
409 std::string GetUID();
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 std::string &);
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 char *);
423 /** Build the ISUPPORT string by triggering all modules On005Numeric events
425 void BuildISupport();
427 /** List of server names we've seen.
429 servernamelist servernames;
431 /** Time this ircd was booted
435 /** Config file pathname specified on the commandline or via ./configure
437 char ConfigFileName[MAXBUF];
439 /** Mode handler, handles mode setting and removal
443 /** Command parser, handles client to server commands
445 CommandParser* Parser;
447 /** Socket engine, handles socket activity events
451 /** Thread engine, Handles threading where required
453 ThreadEngine* Threads;
455 /** The thread/class used to read config files in REHASH and on startup
457 ConfigReaderThread* ConfigThread;
459 /** LogManager handles logging.
463 /** ModuleManager contains everything related to loading/unloading
466 ModuleManager* Modules;
468 /** BanCacheManager is used to speed up checking of restrictions on connection
471 BanCacheManager *BanCache;
473 /** Stats class, holds miscellaneous stats counters
477 /** Server Config class, holds configuration file data
479 ServerConfig* Config;
481 /** Snomask manager - handles routing of snomask messages
486 /** DNS class, provides resolver facilities to the core and modules
490 /** Timer manager class, triggers Timer timer events
492 TimerManager* Timers;
494 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
496 XLineManager* XLines;
498 /** User manager. Various methods and data associated with users.
502 /** Channel list, a hash_map containing all channels XXX move to channel manager class
506 /** List of the open ports
508 std::vector<ListenSocketBase *> ports;
510 /** Set to the current signal recieved
514 /** Protocol interface, overridden by server protocol modules
516 ProtocolInterface* PI;
518 /** Get the current time
519 * Because this only calls time() once every time around the mainloop,
520 * it is much faster than calling time() directly.
521 * @return The current time as an epoch value (time_t)
525 /** Process a user whos socket has been flagged as active
526 * @param cu The user to process
527 * @return There is no actual return value, however upon exit, the user 'cu' may have been
528 * marked for deletion in the global CullList.
530 caller1<void, User*> ProcessUser;
532 /** Bind all ports specified in the configuration file.
533 * @return The number of ports bound without error
535 int BindPorts(FailedPortList &failed_ports);
537 /** Binds a socket on an already open file descriptor
538 * @param sockfd A valid file descriptor of an open socket
539 * @param port The port number to bind to
540 * @param addr The address to bind to (IP only)
541 * @return True if the port was bound successfully
543 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
545 /** Adds a server name to the list of servers we've seen
546 * @param The servername to add
548 void AddServerName(const std::string &servername);
550 /** Finds a cached char* pointer of a server name,
551 * This is used to optimize User by storing only the pointer to the name
552 * @param The servername to find
553 * @return A pointer to this name, gauranteed to never become invalid
555 const char* FindServerNamePtr(const std::string &servername);
557 /** Returns true if we've seen the given server name before
558 * @param The servername to find
559 * @return True if we've seen this server name before
561 bool FindServerName(const std::string &servername);
563 /** Gets the GECOS (description) field of the given server.
564 * If the servername is not that of the local server, the name
565 * is passed to handling modules which will attempt to determine
566 * the GECOS that bleongs to the given servername.
567 * @param servername The servername to find the description of
568 * @return The description of this server, or of the local server
570 std::string GetServerDescription(const char* servername);
572 /** Find a user in the nick hash.
573 * If the user cant be found in the nick hash check the uuid hash
574 * @param nick The nickname to find
575 * @return A pointer to the user, or NULL if the user does not exist
577 User* FindNick(const std::string &nick);
579 /** Find a user in the nick hash.
580 * If the user cant be found in the nick hash check the uuid hash
581 * @param nick The nickname to find
582 * @return A pointer to the user, or NULL if the user does not exist
584 User* FindNick(const char* nick);
586 /** Find a user in the nick hash ONLY
588 User* FindNickOnly(const char* nick);
590 /** Find a user in the nick hash ONLY
592 User* FindNickOnly(const std::string &nick);
594 /** Find a channel in the channels hash
595 * @param chan The channel to find
596 * @return A pointer to the channel, or NULL if the channel does not exist
598 Channel* FindChan(const std::string &chan);
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 char* chan);
606 /** Check we aren't running as root, and exit if we are
607 * @return Depending on the configuration, this function may never return
611 /** Determine the right path for, and open, the logfile
612 * @param argv The argv passed to main() initially, used to calculate program path
613 * @param argc The argc passed to main() initially, used to calculate program path
614 * @return True if the log could be opened, false if otherwise
616 bool OpenLog(char** argv, int argc);
618 /** Return true if a channel name is valid
619 * @param chname A channel name to verify
620 * @return True if the name is valid
622 caller2<bool, const char*, size_t> IsChannel;
624 /** Return true if str looks like a server ID
625 * @param string to check against
627 caller1<bool, const std::string&> IsSID;
629 /** Rehash the local server
631 caller1<void, const std::string&> Rehash;
633 /** Handles incoming signals after being set
634 * @param signal the signal recieved
636 void SignalHandler(int signal);
638 /** Sets the signal recieved
639 * @param signal the signal recieved
641 static void SetSignal(int signal);
643 /** Causes the server to exit after unloading modules and
644 * closing all open file descriptors.
646 * @param The exit code to give to the operating system
647 * (See the ExitStatus enum for valid values)
649 void Exit(int status);
651 /** Causes the server to exit immediately with exit code 0.
652 * The status code is required for signal handlers, and ignored.
654 static void QuickExit(int status);
656 /** Return a count of channels on the network
657 * @return The number of channels
661 /** Send an error notice to all local users, opered and unopered
662 * @param s The error string to send
664 void SendError(const std::string &s);
666 /** Return true if a nickname is valid
667 * @param n A nickname to verify
668 * @return True if the nick is valid
670 caller2<bool, const char*, size_t> IsNick;
672 /** Return true if an ident is valid
673 * @param An ident to verify
674 * @return True if the ident is valid
676 caller1<bool, const char*> IsIdent;
678 /** Add a dns Resolver class to this server's active set
679 * @param r The resolver to add
680 * @param cached If this value is true, then the cache will
681 * be searched for the DNS result, immediately. If the value is
682 * false, then a request will be sent to the nameserver, and the
683 * result will not be immediately available. You should usually
684 * use the boolean value which you passed to the Resolver
685 * constructor, which Resolver will set appropriately depending
686 * on if cached results are available and haven't expired. It is
687 * however safe to force this value to false, forcing a remote DNS
688 * lookup, but not an update of the cache.
689 * @return True if the operation completed successfully. Note that
690 * if this method returns true, you should not attempt to access
691 * the resolver class you pass it after this call, as depending upon
692 * the request given, the object may be deleted!
694 bool AddResolver(Resolver* r, bool cached);
696 /** Add a command to this server's command parser
697 * @param f A Command command handler object to add
698 * @throw ModuleException Will throw ModuleExcption if the command already exists
700 void AddCommand(Command *f);
702 /** Send a modechange.
703 * The parameters provided are identical to that sent to the
704 * handler for class cmd_mode.
705 * @param parameters The mode parameters
706 * @param user The user to send error messages to
708 void SendMode(const std::vector<std::string>& parameters, User *user);
710 /** Match two strings using pattern matching, optionally, with a map
711 * to check case against (may be NULL). If map is null, match will be case insensitive.
712 * @param str The literal string to match against
713 * @param mask The glob pattern to match against.
715 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
716 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
718 /** Match two strings using pattern matching, optionally, with a map
719 * to check case against (may be NULL). If map is null, match will be case insensitive.
720 * Supports CIDR patterns as well as globs.
721 * @param str The literal string to match against
722 * @param mask The glob or CIDR pattern to match against.
724 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
725 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
727 /** Call the handler for a given command.
728 * @param commandname The command whos handler you wish to call
729 * @param parameters The mode parameters
730 * @param pcnt The number of items you have given in the first parameter
731 * @param user The user to execute the command as
732 * @return True if the command handler was called successfully
734 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
736 /** Return true if the command is a module-implemented command and the given parameters are valid for it
737 * @param parameters The mode parameters
738 * @param pcnt The number of items you have given in the first parameter
739 * @param user The user to test-execute the command as
740 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
742 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
744 /** Return true if the given parameter is a valid nick!user\@host mask
745 * @param mask A nick!user\@host masak to match against
746 * @return True i the mask is valid
748 bool IsValidMask(const std::string &mask);
750 /** Rehash the local server
754 /** Return the channel whos index number matches that provided
755 * @param The index number of the channel to fetch
756 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
758 Channel* GetChannelIndex(long index);
760 /** Dump text to a user target, splitting it appropriately to fit
761 * @param User the user to dump the text to
762 * @param LinePrefix text to prefix each complete line with
763 * @param TextStream the text to send to the user
765 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
767 /** Check if the given nickmask matches too many users, send errors to the given user
768 * @param nick A nickmask to match against
769 * @param user A user to send error text to
770 * @return True if the nick matches too many users
772 bool NickMatchesEveryone(const std::string &nick, User* user);
774 /** Check if the given IP mask matches too many users, send errors to the given user
775 * @param ip An ipmask to match against
776 * @param user A user to send error text to
777 * @return True if the ip matches too many users
779 bool IPMatchesEveryone(const std::string &ip, User* user);
781 /** Check if the given hostmask matches too many users, send errors to the given user
782 * @param mask A hostmask to match against
783 * @param user A user to send error text to
784 * @return True if the host matches too many users
786 bool HostMatchesEveryone(const std::string &mask, User* user);
788 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
789 * @param str A string containing a time in the form 1y2w3d4h6m5s
790 * (one year, two weeks, three days, four hours, six minutes and five seconds)
791 * @return The total number of seconds
793 long Duration(const std::string &str);
795 /** Attempt to compare a password to a string from the config file.
796 * This will be passed to handling modules which will compare the data
797 * against possible hashed equivalents in the input string.
798 * @param ex The object (user, server, whatever) causing the comparison.
799 * @param data The data from the config file
800 * @param input The data input by the oper
801 * @param hashtype The hash from the config file
802 * @return 0 if the strings match, 1 or -1 if they do not
804 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
806 /** Check if a given server is a uline.
807 * An empty string returns true, this is by design.
808 * @param server The server to check for uline status
809 * @return True if the server is a uline OR the string is empty
811 bool ULine(const char* server);
813 /** Returns true if the uline is 'silent' (doesnt generate
814 * remote connect notices etc).
816 bool SilentULine(const char* server);
818 /** Returns the subversion revision ID of this ircd
819 * @return The revision ID or an empty string
821 std::string GetRevision();
823 /** Returns the full version string of this ircd
824 * @return The version string
826 std::string GetVersionString();
828 /** Attempt to write the process id to a given file
829 * @param filename The PID file to attempt to write to
830 * @return This function may bail if the file cannot be written
832 void WritePID(const std::string &filename);
834 /** This constructor initialises all the subsystems and reads the config file.
835 * @param argc The argument count passed to main()
836 * @param argv The argument list passed to main()
837 * @throw <anything> If anything is thrown from here and makes it to
838 * you, you should probably just give up and go home. Yes, really.
839 * It's that bad. Higher level classes should catch any non-fatal exceptions.
841 InspIRCd(int argc, char** argv);
843 /** Send a line of WHOIS data to a user.
844 * @param user user to send the line to
845 * @param dest user being WHOISed
846 * @param numeric Numeric to send
847 * @param text Text of the numeric
849 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
851 /** Send a line of WHOIS data to a user.
852 * @param user user to send the line to
853 * @param dest user being WHOISed
854 * @param numeric Numeric to send
855 * @param format Format string for the numeric
856 * @param ... Parameters for the format string
858 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
860 /** Quit a user for excess flood, and if they are not
861 * fully registered yet, temporarily zline their IP.
862 * @param current user to quit
864 caller1<void, User*> FloodQuitUser;
866 /** Restart the server.
867 * This function will not return. If an error occurs,
868 * it will throw an instance of CoreException.
869 * @param reason The restart reason to show to all clients
870 * @throw CoreException An instance of CoreException indicating the error from execv().
872 void Restart(const std::string &reason);
874 /** Prepare the ircd for restart or shutdown.
875 * This function unloads all modules which can be unloaded,
876 * closes all open sockets, and closes the logfile.
880 /** This copies the user and channel hash_maps into new hash maps.
881 * This frees memory used by the hash_map allocator (which it neglects
882 * to free, most of the time, using tons of ram)
884 void RehashUsersAndChans();
886 /** Resets the cached max bans value on all channels.
891 /** Return a time_t as a human-readable string.
893 std::string TimeString(time_t curtime);
895 /** Begin execution of the server.
896 * NOTE: this function NEVER returns. Internally,
897 * it will repeatedly loop.
898 * @return The return value for this function is undefined.
902 /** Force all BufferedSockets to be removed which are due to
905 void BufferedSocketCull();
907 /** Adds an extban char to the 005 token.
909 void AddExtBanChar(char c);
911 char* GetReadBuffer()
913 return this->ReadBuffer;