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.
48 /** A list of failed port bindings, used for informational purposes on startup */
49 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
51 /** A cached text file stored with its contents as lines
53 typedef std::deque< std::string > file_cache;
55 /** A configuration key and value pair
57 typedef std::pair< std::string, std::string > KeyVal;
59 /** A list of related configuration keys and values
61 typedef std::vector< KeyVal > KeyValList;
63 /** An entire config file, built up of KeyValLists
65 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
68 #include "inspircd_config.h"
77 #include "usermanager.h"
80 #include "command_parse.h"
82 #include "socketengine.h"
84 #include "cull_list.h"
85 #include "filelogger.h"
88 #include "configreader.h"
89 #include "inspstring.h"
93 #warning Potentially broken system, PATH_MAX undefined
98 * Used to define the maximum number of parameters a command may have.
100 #define MAXPARAMETERS 127
102 /** Returned by some functions to indicate failure.
106 /** Support for librodent -
107 * see http://www.chatspike.net/index.php?z=64
109 #define ETIREDHAMSTERS EAGAIN
111 /** Template function to convert any input type to std::string
113 template<typename T> inline std::string ConvNumeric(const T &in)
115 if (in == 0) return "0";
120 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
127 std::reverse(res,out);
131 /** Template function to convert any input type to std::string
133 inline std::string ConvToStr(const int in)
135 return ConvNumeric(in);
138 /** Template function to convert any input type to std::string
140 inline std::string ConvToStr(const long in)
142 return ConvNumeric(in);
145 /** Template function to convert any input type to std::string
147 inline std::string ConvToStr(const char* in)
152 /** Template function to convert any input type to std::string
154 inline std::string ConvToStr(const bool in)
156 return (in ? "1" : "0");
159 /** Template function to convert any input type to std::string
161 inline std::string ConvToStr(char in)
163 return std::string(in,1);
166 /** Template function to convert any input type to std::string
168 template <class T> inline std::string ConvToStr(const T &in)
170 std::stringstream tmp;
171 if (!(tmp << in)) return std::string();
175 /** Template function to convert any input type to any other type
176 * (usually an integer or numeric type)
178 template<typename T> inline long ConvToInt(const T &in)
180 std::stringstream tmp;
181 if (!(tmp << in)) return 0;
182 return atoi(tmp.str().c_str());
185 /** Template function to convert integer to char, storing result in *res and
186 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
187 * @param T input value
188 * @param V result value
189 * @param R base to convert to
191 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
193 if (base < 2 || base > 16) { *res = 0; return res; }
197 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
201 if ( in < 0 && base == 10) *out++ = '-';
202 std::reverse( res, out );
207 /** This class contains various STATS counters
208 * It is used by the InspIRCd class, which internally
209 * has an instance of it.
211 class serverstats : public classbase
214 /** Number of accepted connections
216 unsigned long statsAccept;
217 /** Number of failed accepts
219 unsigned long statsRefused;
220 /** Number of unknown commands seen
222 unsigned long statsUnknown;
223 /** Number of nickname collisions handled
225 unsigned long statsCollisions;
226 /** Number of DNS queries sent out
228 unsigned long statsDns;
229 /** Number of good DNS replies received
230 * NOTE: This may not tally to the number sent out,
231 * due to timeouts and other latency issues.
233 unsigned long statsDnsGood;
234 /** Number of bad (negative) DNS replies received
235 * NOTE: This may not tally to the number sent out,
236 * due to timeouts and other latency issues.
238 unsigned long statsDnsBad;
239 /** Number of inbound connections seen
241 unsigned long statsConnects;
242 /** Total bytes of data transmitted
245 /** Total bytes of data received
248 /** Cpu usage at last sample
251 /** Time last sample was read
254 /** The constructor initializes all the counts to zero
257 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
258 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
265 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
266 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
267 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
268 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
269 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
270 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
271 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
272 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
274 /* Forward declaration - required */
276 class BanCacheManager;
278 class CoreExport ConfigReaderThread : public Thread
280 InspIRCd* ServerInstance;
284 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
288 virtual ~ConfigReaderThread()
295 /** The main class of the irc server.
296 * This class contains instances of all the other classes
297 * in this software, with the exception of the base class,
298 * classbase. Amongst other things, it contains a ModeParser,
299 * a DNS object, a CommandParser object, and a list of active
300 * Module objects, and facilities for Module objects to
301 * interact with the core system it implements.
303 class CoreExport InspIRCd : public classbase
306 /** Holds the current UID. Used to generate the next one.
308 char current_uid[UUID_LENGTH];
310 /** Set up the signal handlers
314 /** Daemonize the ircd and close standard input/output streams
315 * @return True if the program daemonized succesfully
319 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
320 * @param TIME the current time
322 void DoSocketTimeouts(time_t TIME);
324 /** Increments the current UID by one.
326 void IncrementUID(int pos);
328 /** Perform background user events such as PING checks
330 void DoBackgroundUserStuff();
332 /** Returns true when all modules have done pre-registration checks on a user
333 * @param user The user to verify
334 * @return True if all modules have finished checking this user
336 bool AllModulesReportReady(User* user);
338 /** Logfile pathname specified on the commandline, or empty string
340 char LogFileName[MAXBUF];
342 /** The current time, updated in the mainloop
346 /** The time that was recorded last time around the mainloop
350 /** A 64k buffer used to read client lines into
352 char ReadBuffer[65535];
354 /** Used when connecting clients
356 irc::sockets::insp_sockaddr client, server;
358 /** Used when connecting clients
368 /** Global cull list, will be processed on next iteration
370 CullList GlobalCulls;
374 ProcessUserHandler HandleProcessUser;
375 IsNickHandler HandleIsNick;
376 IsIdentHandler HandleIsIdent;
377 FindDescriptorHandler HandleFindDescriptor;
378 FloodQuitUserHandler HandleFloodQuitUser;
379 IsChannelHandler HandleIsChannel;
380 IsSIDHandler HandleIsSID;
381 RehashHandler HandleRehash;
383 /** BufferedSocket classes pending deletion after being closed.
384 * We don't delete these immediately as this may cause a segmentation fault.
386 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
388 /** 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
391 * SendMode expects a User* to send the numeric replies
392 * back to, so we create it a fake user that isnt in the user
393 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
394 * falls into the abyss :p
398 /** Returns the next available UID for this server.
400 std::string GetUID();
402 /** Find a user in the UUID hash
403 * @param nick The nickname to find
404 * @return A pointer to the user, or NULL if the user does not exist
406 User *FindUUID(const std::string &);
408 /** Find a user in the UUID hash
409 * @param nick The nickname to find
410 * @return A pointer to the user, or NULL if the user does not exist
412 User *FindUUID(const char *);
414 /** Build the ISUPPORT string by triggering all modules On005Numeric events
416 void BuildISupport();
418 /** List of server names we've seen.
420 servernamelist servernames;
422 /** Time this ircd was booted
426 /** Config file pathname specified on the commandline or via ./configure
428 char ConfigFileName[MAXBUF];
430 /** Mode handler, handles mode setting and removal
434 /** Command parser, handles client to server commands
436 CommandParser* Parser;
438 /** Socket engine, handles socket activity events
442 /** Thread engine, Handles threading where required
444 ThreadEngine* Threads;
446 /** The thread/class used to read config files in REHASH and on startup
448 ConfigReaderThread* ConfigThread;
450 /** LogManager handles logging.
454 /** ModuleManager contains everything related to loading/unloading
457 ModuleManager* Modules;
459 /** BanCacheManager is used to speed up checking of restrictions on connection
462 BanCacheManager *BanCache;
464 /** Stats class, holds miscellaneous stats counters
468 /** Server Config class, holds configuration file data
470 ServerConfig* Config;
472 /** Snomask manager - handles routing of snomask messages
477 /** DNS class, provides resolver facilities to the core and modules
481 /** Timer manager class, triggers Timer timer events
483 TimerManager* Timers;
485 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
487 XLineManager* XLines;
489 /** User manager. Various methods and data associated with users.
493 /** Channel list, a hash_map containing all channels XXX move to channel manager class
497 /** Set to the current signal recieved
501 /** Protocol interface, overridden by server protocol modules
503 ProtocolInterface* PI;
505 /** Get the current time
506 * Because this only calls time() once every time around the mainloop,
507 * it is much faster than calling time() directly.
508 * @return The current time as an epoch value (time_t)
512 /** Process a user whos socket has been flagged as active
513 * @param cu The user to process
514 * @return There is no actual return value, however upon exit, the user 'cu' may have been
515 * marked for deletion in the global CullList.
517 caller1<void, User*> ProcessUser;
519 /** Bind all ports specified in the configuration file.
520 * @param bail True if the function should bail back to the shell on failure
521 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
522 * @return The number of ports actually bound without error
524 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
526 /** Binds a socket on an already open file descriptor
527 * @param sockfd A valid file descriptor of an open socket
528 * @param port The port number to bind to
529 * @param addr The address to bind to (IP only)
530 * @return True if the port was bound successfully
532 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
534 /** Adds a server name to the list of servers we've seen
535 * @param The servername to add
537 void AddServerName(const std::string &servername);
539 /** Finds a cached char* pointer of a server name,
540 * This is used to optimize User by storing only the pointer to the name
541 * @param The servername to find
542 * @return A pointer to this name, gauranteed to never become invalid
544 const char* FindServerNamePtr(const std::string &servername);
546 /** Returns true if we've seen the given server name before
547 * @param The servername to find
548 * @return True if we've seen this server name before
550 bool FindServerName(const std::string &servername);
552 /** Gets the GECOS (description) field of the given server.
553 * If the servername is not that of the local server, the name
554 * is passed to handling modules which will attempt to determine
555 * the GECOS that bleongs to the given servername.
556 * @param servername The servername to find the description of
557 * @return The description of this server, or of the local server
559 std::string GetServerDescription(const char* servername);
561 /** Find a user in the nick hash.
562 * If the user cant be found in the nick hash check the uuid hash
563 * @param nick The nickname to find
564 * @return A pointer to the user, or NULL if the user does not exist
566 User* FindNick(const std::string &nick);
568 /** Find a user in the nick hash.
569 * If the user cant be found in the nick hash check the uuid hash
570 * @param nick The nickname to find
571 * @return A pointer to the user, or NULL if the user does not exist
573 User* FindNick(const char* nick);
575 /** Find a user in the nick hash ONLY
577 User* FindNickOnly(const char* nick);
579 /** Find a user in the nick hash ONLY
581 User* FindNickOnly(const std::string &nick);
583 /** Find a channel in the channels hash
584 * @param chan The channel to find
585 * @return A pointer to the channel, or NULL if the channel does not exist
587 Channel* FindChan(const std::string &chan);
589 /** Find a channel in the channels hash
590 * @param chan The channel to find
591 * @return A pointer to the channel, or NULL if the channel does not exist
593 Channel* FindChan(const char* chan);
595 /** Check for a 'die' tag in the config file, and abort if found
596 * @return Depending on the configuration, this function may never return
600 /** Check we aren't running as root, and exit if we are
601 * @return Depending on the configuration, this function may never return
605 /** Determine the right path for, and open, the logfile
606 * @param argv The argv passed to main() initially, used to calculate program path
607 * @param argc The argc passed to main() initially, used to calculate program path
608 * @return True if the log could be opened, false if otherwise
610 bool OpenLog(char** argv, int argc);
612 /** Return true if a channel name is valid
613 * @param chname A channel name to verify
614 * @return True if the name is valid
616 caller2<bool, const char*, size_t> IsChannel;
618 /** Return true if str looks like a server ID
619 * @param string to check against
621 caller1<bool, const std::string&> IsSID;
623 /** Rehash the local server
625 caller1<void, const std::string&> Rehash;
627 /** Handles incoming signals after being set
628 * @param signal the signal recieved
630 void SignalHandler(int signal);
632 /** Sets the signal recieved
633 * @param signal the signal recieved
635 static void SetSignal(int signal);
637 /** Causes the server to exit after unloading modules and
638 * closing all open file descriptors.
640 * @param The exit code to give to the operating system
641 * (See the ExitStatus enum for valid values)
643 void Exit(int status);
645 /** Causes the server to exit immediately with exit code 0.
646 * The status code is required for signal handlers, and ignored.
648 static void QuickExit(int status);
650 /** Return a count of channels on the network
651 * @return The number of channels
655 /** Send an error notice to all local users, opered and unopered
656 * @param s The error string to send
658 void SendError(const std::string &s);
660 /** Return true if a nickname is valid
661 * @param n A nickname to verify
662 * @return True if the nick is valid
664 caller2<bool, const char*, size_t> IsNick;
666 /** Return true if an ident is valid
667 * @param An ident to verify
668 * @return True if the ident is valid
670 caller1<bool, const char*> IsIdent;
672 /** Find a username by their file descriptor.
673 * It is preferred to use this over directly accessing the fd_ref_table array.
674 * @param socket The file descriptor of a user
675 * @return A pointer to the user if the user exists locally on this descriptor
677 caller1<User*, int> FindDescriptor;
679 /** Add a dns Resolver class to this server's active set
680 * @param r The resolver to add
681 * @param cached If this value is true, then the cache will
682 * be searched for the DNS result, immediately. If the value is
683 * false, then a request will be sent to the nameserver, and the
684 * result will not be immediately available. You should usually
685 * use the boolean value which you passed to the Resolver
686 * constructor, which Resolver will set appropriately depending
687 * on if cached results are available and haven't expired. It is
688 * however safe to force this value to false, forcing a remote DNS
689 * lookup, but not an update of the cache.
690 * @return True if the operation completed successfully. Note that
691 * if this method returns true, you should not attempt to access
692 * the resolver class you pass it after this call, as depending upon
693 * the request given, the object may be deleted!
695 bool AddResolver(Resolver* r, bool cached);
697 /** Add a command to this server's command parser
698 * @param f A Command command handler object to add
699 * @throw ModuleException Will throw ModuleExcption if the command already exists
701 void AddCommand(Command *f);
703 /** Send a modechange.
704 * The parameters provided are identical to that sent to the
705 * handler for class cmd_mode.
706 * @param parameters The mode parameters
707 * @param pcnt The number of items you have given in the first parameter
708 * @param user The user to send error messages to
710 void SendMode(const std::vector<std::string>& parameters, User *user);
712 /** Match two strings using pattern matching.
713 * This operates identically to the global function match(),
714 * except for that it takes std::string arguments rather than
716 * @param sliteral The literal string to match against
717 * @param spattern The pattern to match against. CIDR and globs are supported.
719 bool MatchText(const std::string &sliteral, const std::string &spattern);
721 /** Call the handler for a given command.
722 * @param commandname The command whos handler you wish to call
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 execute the command as
726 * @return True if the command handler was called successfully
728 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
730 /** Return true if the command is a module-implemented command and the given parameters are valid for it
731 * @param parameters The mode parameters
732 * @param pcnt The number of items you have given in the first parameter
733 * @param user The user to test-execute the command as
734 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
736 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
738 /** Return true if the given parameter is a valid nick!user\@host mask
739 * @param mask A nick!user\@host masak to match against
740 * @return True i the mask is valid
742 bool IsValidMask(const std::string &mask);
744 /** Rehash the local server
748 /** Return the channel whos index number matches that provided
749 * @param The index number of the channel to fetch
750 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
752 Channel* GetChannelIndex(long index);
754 /** Dump text to a user target, splitting it appropriately to fit
755 * @param User the user to dump the text to
756 * @param LinePrefix text to prefix each complete line with
757 * @param TextStream the text to send to the user
759 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
761 /** Check if the given nickmask matches too many users, send errors to the given user
762 * @param nick A nickmask to match against
763 * @param user A user to send error text to
764 * @return True if the nick matches too many users
766 bool NickMatchesEveryone(const std::string &nick, User* user);
768 /** Check if the given IP mask matches too many users, send errors to the given user
769 * @param ip An ipmask to match against
770 * @param user A user to send error text to
771 * @return True if the ip matches too many users
773 bool IPMatchesEveryone(const std::string &ip, User* user);
775 /** Check if the given hostmask matches too many users, send errors to the given user
776 * @param mask A hostmask to match against
777 * @param user A user to send error text to
778 * @return True if the host matches too many users
780 bool HostMatchesEveryone(const std::string &mask, User* user);
782 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
783 * @param str A string containing a time in the form 1y2w3d4h6m5s
784 * (one year, two weeks, three days, four hours, six minutes and five seconds)
785 * @return The total number of seconds
787 long Duration(const std::string &str);
789 /** Attempt to compare a password to a string from the config file.
790 * This will be passed to handling modules which will compare the data
791 * against possible hashed equivalents in the input string.
792 * @param ex The object (user, server, whatever) causing the comparison.
793 * @param data The data from the config file
794 * @param input The data input by the oper
795 * @param hashtype The hash from the config file
796 * @return 0 if the strings match, 1 or -1 if they do not
798 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
800 /** Check if a given server is a uline.
801 * An empty string returns true, this is by design.
802 * @param server The server to check for uline status
803 * @return True if the server is a uline OR the string is empty
805 bool ULine(const char* server);
807 /** Returns true if the uline is 'silent' (doesnt generate
808 * remote connect notices etc).
810 bool SilentULine(const char* server);
812 /** Returns the subversion revision ID of this ircd
813 * @return The revision ID or an empty string
815 std::string GetRevision();
817 /** Returns the full version string of this ircd
818 * @return The version string
820 std::string GetVersionString();
822 /** Attempt to write the process id to a given file
823 * @param filename The PID file to attempt to write to
824 * @return This function may bail if the file cannot be written
826 void WritePID(const std::string &filename);
828 /** This constructor initialises all the subsystems and reads the config file.
829 * @param argc The argument count passed to main()
830 * @param argv The argument list passed to main()
831 * @throw <anything> If anything is thrown from here and makes it to
832 * you, you should probably just give up and go home. Yes, really.
833 * It's that bad. Higher level classes should catch any non-fatal exceptions.
835 InspIRCd(int argc, char** argv);
837 /** Send a line of WHOIS data to a user.
838 * @param user user to send the line to
839 * @param dest user being WHOISed
840 * @param numeric Numeric to send
841 * @param text Text of the numeric
843 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
845 /** Send a line of WHOIS data to a user.
846 * @param user user to send the line to
847 * @param dest user being WHOISed
848 * @param numeric Numeric to send
849 * @param format Format string for the numeric
850 * @param ... Parameters for the format string
852 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
854 /** Quit a user for excess flood, and if they are not
855 * fully registered yet, temporarily zline their IP.
856 * @param current user to quit
858 caller1<void, User*> FloodQuitUser;
860 /** Restart the server.
861 * This function will not return. If an error occurs,
862 * it will throw an instance of CoreException.
863 * @param reason The restart reason to show to all clients
864 * @throw CoreException An instance of CoreException indicating the error from execv().
866 void Restart(const std::string &reason);
868 /** Prepare the ircd for restart or shutdown.
869 * This function unloads all modules which can be unloaded,
870 * closes all open sockets, and closes the logfile.
874 /** This copies the user and channel hash_maps into new hash maps.
875 * This frees memory used by the hash_map allocator (which it neglects
876 * to free, most of the time, using tons of ram)
878 void RehashUsersAndChans();
880 /** Resets the cached max bans value on all channels.
885 /** Return a time_t as a human-readable string.
887 std::string TimeString(time_t curtime);
889 /** Begin execution of the server.
890 * NOTE: this function NEVER returns. Internally,
891 * it will repeatedly loop.
892 * @return The return value for this function is undefined.
896 /** Force all BufferedSockets to be removed which are due to
899 void BufferedSocketCull();
901 /** Adds an extban char to the 005 token.
903 void AddExtBanChar(char c);
905 char* GetReadBuffer()
907 return this->ReadBuffer;