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 /** 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
396 * SendMode expects a User* to send the numeric replies
397 * back to, so we create it a fake user that isnt in the user
398 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
399 * falls into the abyss :p
403 /** Returns the next available UID for this server.
405 std::string GetUID();
407 /** Find a user in the UUID hash
408 * @param nick The nickname to find
409 * @return A pointer to the user, or NULL if the user does not exist
411 User *FindUUID(const std::string &);
413 /** Find a user in the UUID hash
414 * @param nick The nickname to find
415 * @return A pointer to the user, or NULL if the user does not exist
417 User *FindUUID(const char *);
419 /** Build the ISUPPORT string by triggering all modules On005Numeric events
421 void BuildISupport();
423 /** List of server names we've seen.
425 servernamelist servernames;
427 /** Time this ircd was booted
431 /** Config file pathname specified on the commandline or via ./configure
433 char ConfigFileName[MAXBUF];
435 /** Mode handler, handles mode setting and removal
439 /** Command parser, handles client to server commands
441 CommandParser* Parser;
443 /** Socket engine, handles socket activity events
447 /** Thread engine, Handles threading where required
449 ThreadEngine* Threads;
451 /** Mutex engine, handles mutexes for threading where required
453 MutexFactory* Mutexes;
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 /** Set to the current signal recieved
510 /** Protocol interface, overridden by server protocol modules
512 ProtocolInterface* PI;
514 /** Get the current time
515 * Because this only calls time() once every time around the mainloop,
516 * it is much faster than calling time() directly.
517 * @return The current time as an epoch value (time_t)
521 /** Process a user whos socket has been flagged as active
522 * @param cu The user to process
523 * @return There is no actual return value, however upon exit, the user 'cu' may have been
524 * marked for deletion in the global CullList.
526 caller1<void, User*> ProcessUser;
528 /** Bind all ports specified in the configuration file.
529 * @param bail True if the function should bail back to the shell on failure
530 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
531 * @return The number of ports actually bound without error
533 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
535 /** Binds a socket on an already open file descriptor
536 * @param sockfd A valid file descriptor of an open socket
537 * @param port The port number to bind to
538 * @param addr The address to bind to (IP only)
539 * @return True if the port was bound successfully
541 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
543 /** Adds a server name to the list of servers we've seen
544 * @param The servername to add
546 void AddServerName(const std::string &servername);
548 /** Finds a cached char* pointer of a server name,
549 * This is used to optimize User by storing only the pointer to the name
550 * @param The servername to find
551 * @return A pointer to this name, gauranteed to never become invalid
553 const char* FindServerNamePtr(const std::string &servername);
555 /** Returns true if we've seen the given server name before
556 * @param The servername to find
557 * @return True if we've seen this server name before
559 bool FindServerName(const std::string &servername);
561 /** Gets the GECOS (description) field of the given server.
562 * If the servername is not that of the local server, the name
563 * is passed to handling modules which will attempt to determine
564 * the GECOS that bleongs to the given servername.
565 * @param servername The servername to find the description of
566 * @return The description of this server, or of the local server
568 std::string GetServerDescription(const char* servername);
570 /** Find a user in the nick hash.
571 * If the user cant be found in the nick hash check the uuid hash
572 * @param nick The nickname to find
573 * @return A pointer to the user, or NULL if the user does not exist
575 User* FindNick(const std::string &nick);
577 /** Find a user in the nick hash.
578 * If the user cant be found in the nick hash check the uuid hash
579 * @param nick The nickname to find
580 * @return A pointer to the user, or NULL if the user does not exist
582 User* FindNick(const char* nick);
584 /** Find a user in the nick hash ONLY
586 User* FindNickOnly(const char* nick);
588 /** Find a user in the nick hash ONLY
590 User* FindNickOnly(const std::string &nick);
592 /** Find a channel in the channels hash
593 * @param chan The channel to find
594 * @return A pointer to the channel, or NULL if the channel does not exist
596 Channel* FindChan(const std::string &chan);
598 /** Find a channel in the channels hash
599 * @param chan The channel to find
600 * @return A pointer to the channel, or NULL if the channel does not exist
602 Channel* FindChan(const char* chan);
604 /** Check for a 'die' tag in the config file, and abort if found
605 * @return Depending on the configuration, this function may never return
609 /** Check we aren't running as root, and exit if we are
610 * @return Depending on the configuration, this function may never return
614 /** Determine the right path for, and open, the logfile
615 * @param argv The argv passed to main() initially, used to calculate program path
616 * @param argc The argc passed to main() initially, used to calculate program path
617 * @return True if the log could be opened, false if otherwise
619 bool OpenLog(char** argv, int argc);
621 /** Return true if a channel name is valid
622 * @param chname A channel name to verify
623 * @return True if the name is valid
625 caller2<bool, const char*, size_t> IsChannel;
627 /** Return true if str looks like a server ID
628 * @param string to check against
630 caller1<bool, const std::string&> IsSID;
632 /** Rehash the local server
634 caller1<void, const std::string&> Rehash;
636 /** Handles incoming signals after being set
637 * @param signal the signal recieved
639 void SignalHandler(int signal);
641 /** Sets the signal recieved
642 * @param signal the signal recieved
644 static void SetSignal(int signal);
646 /** Causes the server to exit after unloading modules and
647 * closing all open file descriptors.
649 * @param The exit code to give to the operating system
650 * (See the ExitStatus enum for valid values)
652 void Exit(int status);
654 /** Causes the server to exit immediately with exit code 0.
655 * The status code is required for signal handlers, and ignored.
657 static void QuickExit(int status);
659 /** Return a count of channels on the network
660 * @return The number of channels
664 /** Send an error notice to all local users, opered and unopered
665 * @param s The error string to send
667 void SendError(const std::string &s);
669 /** Return true if a nickname is valid
670 * @param n A nickname to verify
671 * @return True if the nick is valid
673 caller2<bool, const char*, size_t> IsNick;
675 /** Return true if an ident is valid
676 * @param An ident to verify
677 * @return True if the ident is valid
679 caller1<bool, const char*> IsIdent;
681 /** Find a username by their file descriptor.
682 * It is preferred to use this over directly accessing the fd_ref_table array.
683 * @param socket The file descriptor of a user
684 * @return A pointer to the user if the user exists locally on this descriptor
686 caller1<User*, int> FindDescriptor;
688 /** Add a dns Resolver class to this server's active set
689 * @param r The resolver to add
690 * @param cached If this value is true, then the cache will
691 * be searched for the DNS result, immediately. If the value is
692 * false, then a request will be sent to the nameserver, and the
693 * result will not be immediately available. You should usually
694 * use the boolean value which you passed to the Resolver
695 * constructor, which Resolver will set appropriately depending
696 * on if cached results are available and haven't expired. It is
697 * however safe to force this value to false, forcing a remote DNS
698 * lookup, but not an update of the cache.
699 * @return True if the operation completed successfully. Note that
700 * if this method returns true, you should not attempt to access
701 * the resolver class you pass it after this call, as depending upon
702 * the request given, the object may be deleted!
704 bool AddResolver(Resolver* r, bool cached);
706 /** Add a command to this server's command parser
707 * @param f A Command command handler object to add
708 * @throw ModuleException Will throw ModuleExcption if the command already exists
710 void AddCommand(Command *f);
712 /** Send a modechange.
713 * The parameters provided are identical to that sent to the
714 * handler for class cmd_mode.
715 * @param parameters The mode parameters
716 * @param pcnt The number of items you have given in the first parameter
717 * @param user The user to send error messages to
719 void SendMode(const std::vector<std::string>& parameters, User *user);
721 /** Match two strings using pattern matching, optionally, with a map
722 * to check case against (may be NULL). If map is null, match will be case insensitive.
723 * @param str The literal string to match against
724 * @param mask The glob pattern to match against.
726 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
727 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
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 * Supports CIDR patterns as well as globs.
732 * @param str The literal string to match against
733 * @param mask The glob or CIDR pattern to match against.
735 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
736 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
738 /** Call the handler for a given command.
739 * @param commandname The command whos handler you wish to call
740 * @param parameters The mode parameters
741 * @param pcnt The number of items you have given in the first parameter
742 * @param user The user to execute the command as
743 * @return True if the command handler was called successfully
745 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
747 /** Return true if the command is a module-implemented command and the given parameters are valid for it
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 test-execute the command as
751 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
753 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
755 /** Return true if the given parameter is a valid nick!user\@host mask
756 * @param mask A nick!user\@host masak to match against
757 * @return True i the mask is valid
759 bool IsValidMask(const std::string &mask);
761 /** Rehash the local server
765 /** Return the channel whos index number matches that provided
766 * @param The index number of the channel to fetch
767 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
769 Channel* GetChannelIndex(long index);
771 /** Dump text to a user target, splitting it appropriately to fit
772 * @param User the user to dump the text to
773 * @param LinePrefix text to prefix each complete line with
774 * @param TextStream the text to send to the user
776 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
778 /** Check if the given nickmask matches too many users, send errors to the given user
779 * @param nick A nickmask to match against
780 * @param user A user to send error text to
781 * @return True if the nick matches too many users
783 bool NickMatchesEveryone(const std::string &nick, User* user);
785 /** Check if the given IP mask matches too many users, send errors to the given user
786 * @param ip An ipmask to match against
787 * @param user A user to send error text to
788 * @return True if the ip matches too many users
790 bool IPMatchesEveryone(const std::string &ip, User* user);
792 /** Check if the given hostmask matches too many users, send errors to the given user
793 * @param mask A hostmask to match against
794 * @param user A user to send error text to
795 * @return True if the host matches too many users
797 bool HostMatchesEveryone(const std::string &mask, User* user);
799 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
800 * @param str A string containing a time in the form 1y2w3d4h6m5s
801 * (one year, two weeks, three days, four hours, six minutes and five seconds)
802 * @return The total number of seconds
804 long Duration(const std::string &str);
806 /** Attempt to compare a password to a string from the config file.
807 * This will be passed to handling modules which will compare the data
808 * against possible hashed equivalents in the input string.
809 * @param ex The object (user, server, whatever) causing the comparison.
810 * @param data The data from the config file
811 * @param input The data input by the oper
812 * @param hashtype The hash from the config file
813 * @return 0 if the strings match, 1 or -1 if they do not
815 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
817 /** Check if a given server is a uline.
818 * An empty string returns true, this is by design.
819 * @param server The server to check for uline status
820 * @return True if the server is a uline OR the string is empty
822 bool ULine(const char* server);
824 /** Returns true if the uline is 'silent' (doesnt generate
825 * remote connect notices etc).
827 bool SilentULine(const char* server);
829 /** Returns the subversion revision ID of this ircd
830 * @return The revision ID or an empty string
832 std::string GetRevision();
834 /** Returns the full version string of this ircd
835 * @return The version string
837 std::string GetVersionString();
839 /** Attempt to write the process id to a given file
840 * @param filename The PID file to attempt to write to
841 * @return This function may bail if the file cannot be written
843 void WritePID(const std::string &filename);
845 /** This constructor initialises all the subsystems and reads the config file.
846 * @param argc The argument count passed to main()
847 * @param argv The argument list passed to main()
848 * @throw <anything> If anything is thrown from here and makes it to
849 * you, you should probably just give up and go home. Yes, really.
850 * It's that bad. Higher level classes should catch any non-fatal exceptions.
852 InspIRCd(int argc, char** argv);
854 /** Send a line of WHOIS data to a user.
855 * @param user user to send the line to
856 * @param dest user being WHOISed
857 * @param numeric Numeric to send
858 * @param text Text of the numeric
860 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
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 format Format string for the numeric
867 * @param ... Parameters for the format string
869 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
871 /** Quit a user for excess flood, and if they are not
872 * fully registered yet, temporarily zline their IP.
873 * @param current user to quit
875 caller1<void, User*> FloodQuitUser;
877 /** Restart the server.
878 * This function will not return. If an error occurs,
879 * it will throw an instance of CoreException.
880 * @param reason The restart reason to show to all clients
881 * @throw CoreException An instance of CoreException indicating the error from execv().
883 void Restart(const std::string &reason);
885 /** Prepare the ircd for restart or shutdown.
886 * This function unloads all modules which can be unloaded,
887 * closes all open sockets, and closes the logfile.
891 /** This copies the user and channel hash_maps into new hash maps.
892 * This frees memory used by the hash_map allocator (which it neglects
893 * to free, most of the time, using tons of ram)
895 void RehashUsersAndChans();
897 /** Resets the cached max bans value on all channels.
902 /** Return a time_t as a human-readable string.
904 std::string TimeString(time_t curtime);
906 /** Begin execution of the server.
907 * NOTE: this function NEVER returns. Internally,
908 * it will repeatedly loop.
909 * @return The return value for this function is undefined.
913 /** Force all BufferedSockets to be removed which are due to
916 void BufferedSocketCull();
918 /** Adds an extban char to the 005 token.
920 void AddExtBanChar(char c);
922 char* GetReadBuffer()
924 return this->ReadBuffer;