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.
47 /** A list of failed port bindings, used for informational purposes on startup */
48 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
50 /** A cached text file stored with its contents as lines
52 typedef std::deque< std::string > file_cache;
54 /** A configuration key and value pair
56 typedef std::pair< std::string, std::string > KeyVal;
58 /** A list of related configuration keys and values
60 typedef std::vector< KeyVal > KeyValList;
62 /** An entire config file, built up of KeyValLists
64 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
67 #include "inspircd_config.h"
76 #include "usermanager.h"
79 #include "command_parse.h"
81 #include "socketengine.h"
83 #include "cull_list.h"
84 #include "filelogger.h"
87 #include "configreader.h"
88 #include "inspstring.h"
92 #warning Potentially broken system, PATH_MAX undefined
97 * Used to define the maximum number of parameters a command may have.
99 #define MAXPARAMETERS 127
101 /** Returned by some functions to indicate failure.
105 /** Support for librodent -
106 * see http://www.chatspike.net/index.php?z=64
108 #define ETIREDHAMSTERS EAGAIN
110 /** Template function to convert any input type to std::string
112 template<typename T> inline std::string ConvNumeric(const T &in)
114 if (in == 0) return "0";
119 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
126 std::reverse(res,out);
130 /** Template function to convert any input type to std::string
132 inline std::string ConvToStr(const int in)
134 return ConvNumeric(in);
137 /** Template function to convert any input type to std::string
139 inline std::string ConvToStr(const long in)
141 return ConvNumeric(in);
144 /** Template function to convert any input type to std::string
146 inline std::string ConvToStr(const char* in)
151 /** Template function to convert any input type to std::string
153 inline std::string ConvToStr(const bool in)
155 return (in ? "1" : "0");
158 /** Template function to convert any input type to std::string
160 inline std::string ConvToStr(char in)
162 return std::string(in,1);
165 /** Template function to convert any input type to std::string
167 template <class T> inline std::string ConvToStr(const T &in)
169 std::stringstream tmp;
170 if (!(tmp << in)) return std::string();
174 /** Template function to convert any input type to any other type
175 * (usually an integer or numeric type)
177 template<typename T> inline long ConvToInt(const T &in)
179 std::stringstream tmp;
180 if (!(tmp << in)) return 0;
181 return atoi(tmp.str().c_str());
184 /** Template function to convert integer to char, storing result in *res and
185 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
186 * @param T input value
187 * @param V result value
188 * @param R base to convert to
190 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
192 if (base < 2 || base > 16) { *res = 0; return res; }
196 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
200 if ( in < 0 && base == 10) *out++ = '-';
201 std::reverse( res, out );
206 /** This class contains various STATS counters
207 * It is used by the InspIRCd class, which internally
208 * has an instance of it.
210 class serverstats : public classbase
213 /** Number of accepted connections
215 unsigned long statsAccept;
216 /** Number of failed accepts
218 unsigned long statsRefused;
219 /** Number of unknown commands seen
221 unsigned long statsUnknown;
222 /** Number of nickname collisions handled
224 unsigned long statsCollisions;
225 /** Number of DNS queries sent out
227 unsigned long statsDns;
228 /** Number of good DNS replies received
229 * NOTE: This may not tally to the number sent out,
230 * due to timeouts and other latency issues.
232 unsigned long statsDnsGood;
233 /** Number of bad (negative) DNS replies received
234 * NOTE: This may not tally to the number sent out,
235 * due to timeouts and other latency issues.
237 unsigned long statsDnsBad;
238 /** Number of inbound connections seen
240 unsigned long statsConnects;
241 /** Total bytes of data transmitted
244 /** Total bytes of data received
247 /** Cpu usage at last sample
250 /** Time last sample was read
253 /** The constructor initializes all the counts to zero
256 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
257 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
264 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
265 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
266 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
267 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
268 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
269 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
270 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
271 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
273 /* Forward declaration - required */
275 class BanCacheManager;
277 class CoreExport ConfigReaderThread : public Thread
279 InspIRCd* ServerInstance;
283 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
287 virtual ~ConfigReaderThread()
294 /** The main class of the irc server.
295 * This class contains instances of all the other classes
296 * in this software, with the exception of the base class,
297 * classbase. Amongst other things, it contains a ModeParser,
298 * a DNS object, a CommandParser object, and a list of active
299 * Module objects, and facilities for Module objects to
300 * interact with the core system it implements.
302 class CoreExport InspIRCd : public classbase
305 /** Holds the current UID. Used to generate the next one.
307 char current_uid[UUID_LENGTH];
309 /** Set up the signal handlers
313 /** Daemonize the ircd and close standard input/output streams
314 * @return True if the program daemonized succesfully
318 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
319 * @param TIME the current time
321 void DoSocketTimeouts(time_t TIME);
323 /** Increments the current UID by one.
325 void IncrementUID(int pos);
327 /** Perform background user events such as PING checks
329 void DoBackgroundUserStuff();
331 /** Returns true when all modules have done pre-registration checks on a user
332 * @param user The user to verify
333 * @return True if all modules have finished checking this user
335 bool AllModulesReportReady(User* user);
337 /** Logfile pathname specified on the commandline, or empty string
339 char LogFileName[MAXBUF];
341 /** The current time, updated in the mainloop
345 /** The time that was recorded last time around the mainloop
349 /** A 64k buffer used to read client lines into
351 char ReadBuffer[65535];
353 /** Used when connecting clients
355 irc::sockets::insp_sockaddr client, server;
357 /** Used when connecting clients
367 /** Global cull list, will be processed on next iteration
369 CullList GlobalCulls;
373 ProcessUserHandler HandleProcessUser;
374 IsNickHandler HandleIsNick;
375 IsIdentHandler HandleIsIdent;
376 FindDescriptorHandler HandleFindDescriptor;
377 FloodQuitUserHandler HandleFloodQuitUser;
378 IsChannelHandler HandleIsChannel;
379 IsSIDHandler HandleIsSID;
380 RehashHandler HandleRehash;
382 /** BufferedSocket classes pending deletion after being closed.
383 * We don't delete these immediately as this may cause a segmentation fault.
385 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
387 /** 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
390 * SendMode expects a User* to send the numeric replies
391 * back to, so we create it a fake user that isnt in the user
392 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
393 * falls into the abyss :p
397 /** Returns the next available UID for this server.
399 std::string GetUID();
401 /** Find a user in the UUID hash
402 * @param nick The nickname to find
403 * @return A pointer to the user, or NULL if the user does not exist
405 User *FindUUID(const std::string &);
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 char *);
413 /** Build the ISUPPORT string by triggering all modules On005Numeric events
415 void BuildISupport();
417 /** List of server names we've seen.
419 servernamelist servernames;
421 /** Time this ircd was booted
425 /** Config file pathname specified on the commandline or via ./configure
427 char ConfigFileName[MAXBUF];
429 /** Mode handler, handles mode setting and removal
433 /** Command parser, handles client to server commands
435 CommandParser* Parser;
437 /** Socket engine, handles socket activity events
441 /** Thread engine, Handles threading where required
443 ThreadEngine* Threads;
445 /** The thread/class used to read config files in REHASH and on startup
447 ConfigReaderThread* ConfigThread;
449 /** LogManager handles logging.
453 /** ModuleManager contains everything related to loading/unloading
456 ModuleManager* Modules;
458 /** BanCacheManager is used to speed up checking of restrictions on connection
461 BanCacheManager *BanCache;
463 /** Stats class, holds miscellaneous stats counters
467 /** Server Config class, holds configuration file data
469 ServerConfig* Config;
471 /** Snomask manager - handles routing of snomask messages
476 /** DNS class, provides resolver facilities to the core and modules
480 /** Timer manager class, triggers Timer timer events
482 TimerManager* Timers;
484 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
486 XLineManager* XLines;
488 /** User manager. Various methods and data associated with users.
492 /** Channel list, a hash_map containing all channels XXX move to channel manager class
496 /** Set to the current signal recieved
500 /** Protocol interface, overridden by server protocol modules
502 ProtocolInterface* PI;
504 /** Get the current time
505 * Because this only calls time() once every time around the mainloop,
506 * it is much faster than calling time() directly.
507 * @return The current time as an epoch value (time_t)
511 /** Process a user whos socket has been flagged as active
512 * @param cu The user to process
513 * @return There is no actual return value, however upon exit, the user 'cu' may have been
514 * marked for deletion in the global CullList.
516 caller1<void, User*> ProcessUser;
518 /** Bind all ports specified in the configuration file.
519 * @param bail True if the function should bail back to the shell on failure
520 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
521 * @return The number of ports actually bound without error
523 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
525 /** Binds a socket on an already open file descriptor
526 * @param sockfd A valid file descriptor of an open socket
527 * @param port The port number to bind to
528 * @param addr The address to bind to (IP only)
529 * @return True if the port was bound successfully
531 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
533 /** Adds a server name to the list of servers we've seen
534 * @param The servername to add
536 void AddServerName(const std::string &servername);
538 /** Finds a cached char* pointer of a server name,
539 * This is used to optimize User by storing only the pointer to the name
540 * @param The servername to find
541 * @return A pointer to this name, gauranteed to never become invalid
543 const char* FindServerNamePtr(const std::string &servername);
545 /** Returns true if we've seen the given server name before
546 * @param The servername to find
547 * @return True if we've seen this server name before
549 bool FindServerName(const std::string &servername);
551 /** Gets the GECOS (description) field of the given server.
552 * If the servername is not that of the local server, the name
553 * is passed to handling modules which will attempt to determine
554 * the GECOS that bleongs to the given servername.
555 * @param servername The servername to find the description of
556 * @return The description of this server, or of the local server
558 std::string GetServerDescription(const char* servername);
560 /** Find a user in the nick hash.
561 * If the user cant be found in the nick hash check the uuid hash
562 * @param nick The nickname to find
563 * @return A pointer to the user, or NULL if the user does not exist
565 User* FindNick(const std::string &nick);
567 /** Find a user in the nick hash.
568 * If the user cant be found in the nick hash check the uuid hash
569 * @param nick The nickname to find
570 * @return A pointer to the user, or NULL if the user does not exist
572 User* FindNick(const char* nick);
574 /** Find a user in the nick hash ONLY
576 User* FindNickOnly(const char* nick);
578 /** Find a user in the nick hash ONLY
580 User* FindNickOnly(const std::string &nick);
582 /** Find a channel in the channels hash
583 * @param chan The channel to find
584 * @return A pointer to the channel, or NULL if the channel does not exist
586 Channel* FindChan(const std::string &chan);
588 /** Find a channel in the channels hash
589 * @param chan The channel to find
590 * @return A pointer to the channel, or NULL if the channel does not exist
592 Channel* FindChan(const char* chan);
594 /** Check for a 'die' tag in the config file, and abort if found
595 * @return Depending on the configuration, this function may never return
599 /** Check we aren't running as root, and exit if we are
600 * @return Depending on the configuration, this function may never return
604 /** Determine the right path for, and open, the logfile
605 * @param argv The argv passed to main() initially, used to calculate program path
606 * @param argc The argc passed to main() initially, used to calculate program path
607 * @return True if the log could be opened, false if otherwise
609 bool OpenLog(char** argv, int argc);
611 /** Return true if a channel name is valid
612 * @param chname A channel name to verify
613 * @return True if the name is valid
615 caller2<bool, const char*, size_t> IsChannel;
617 /** Return true if str looks like a server ID
618 * @param string to check against
620 caller1<bool, const std::string&> IsSID;
622 /** Rehash the local server
624 caller1<void, const std::string&> Rehash;
626 /** Handles incoming signals after being set
627 * @param signal the signal recieved
629 void SignalHandler(int signal);
631 /** Sets the signal recieved
632 * @param signal the signal recieved
634 static void SetSignal(int signal);
636 /** Causes the server to exit after unloading modules and
637 * closing all open file descriptors.
639 * @param The exit code to give to the operating system
640 * (See the ExitStatus enum for valid values)
642 void Exit(int status);
644 /** Causes the server to exit immediately with exit code 0.
645 * The status code is required for signal handlers, and ignored.
647 static void QuickExit(int status);
649 /** Return a count of channels on the network
650 * @return The number of channels
654 /** Send an error notice to all local users, opered and unopered
655 * @param s The error string to send
657 void SendError(const std::string &s);
659 /** Return true if a nickname is valid
660 * @param n A nickname to verify
661 * @return True if the nick is valid
663 caller2<bool, const char*, size_t> IsNick;
665 /** Return true if an ident is valid
666 * @param An ident to verify
667 * @return True if the ident is valid
669 caller1<bool, const char*> IsIdent;
671 /** Find a username by their file descriptor.
672 * It is preferred to use this over directly accessing the fd_ref_table array.
673 * @param socket The file descriptor of a user
674 * @return A pointer to the user if the user exists locally on this descriptor
676 caller1<User*, int> FindDescriptor;
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 pcnt The number of items you have given in the first parameter
707 * @param user The user to send error messages to
709 void SendMode(const std::vector<std::string>& parameters, User *user);
711 /** Match two strings using pattern matching.
712 * This operates identically to the global function match(),
713 * except for that it takes std::string arguments rather than
715 * @param sliteral The literal string to match against
716 * @param spattern The pattern to match against. CIDR and globs are supported.
718 bool MatchText(const std::string &sliteral, const std::string &spattern);
720 /** Call the handler for a given command.
721 * @param commandname The command whos handler you wish to call
722 * @param parameters The mode parameters
723 * @param pcnt The number of items you have given in the first parameter
724 * @param user The user to execute the command as
725 * @return True if the command handler was called successfully
727 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
729 /** Return true if the command is a module-implemented command and the given parameters are valid for it
730 * @param parameters The mode parameters
731 * @param pcnt The number of items you have given in the first parameter
732 * @param user The user to test-execute the command as
733 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
735 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
737 /** Return true if the given parameter is a valid nick!user\@host mask
738 * @param mask A nick!user\@host masak to match against
739 * @return True i the mask is valid
741 bool IsValidMask(const std::string &mask);
743 /** Rehash the local server
747 /** Return the channel whos index number matches that provided
748 * @param The index number of the channel to fetch
749 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
751 Channel* GetChannelIndex(long index);
753 /** Dump text to a user target, splitting it appropriately to fit
754 * @param User the user to dump the text to
755 * @param LinePrefix text to prefix each complete line with
756 * @param TextStream the text to send to the user
758 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
760 /** Check if the given nickmask matches too many users, send errors to the given user
761 * @param nick A nickmask to match against
762 * @param user A user to send error text to
763 * @return True if the nick matches too many users
765 bool NickMatchesEveryone(const std::string &nick, User* user);
767 /** Check if the given IP mask matches too many users, send errors to the given user
768 * @param ip An ipmask to match against
769 * @param user A user to send error text to
770 * @return True if the ip matches too many users
772 bool IPMatchesEveryone(const std::string &ip, User* user);
774 /** Check if the given hostmask matches too many users, send errors to the given user
775 * @param mask A hostmask to match against
776 * @param user A user to send error text to
777 * @return True if the host matches too many users
779 bool HostMatchesEveryone(const std::string &mask, User* user);
781 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
782 * @param str A string containing a time in the form 1y2w3d4h6m5s
783 * (one year, two weeks, three days, four hours, six minutes and five seconds)
784 * @return The total number of seconds
786 long Duration(const std::string &str);
788 /** Attempt to compare a password to a string from the config file.
789 * This will be passed to handling modules which will compare the data
790 * against possible hashed equivalents in the input string.
791 * @param ex The object (user, server, whatever) causing the comparison.
792 * @param data The data from the config file
793 * @param input The data input by the oper
794 * @param hashtype The hash from the config file
795 * @return 0 if the strings match, 1 or -1 if they do not
797 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
799 /** Check if a given server is a uline.
800 * An empty string returns true, this is by design.
801 * @param server The server to check for uline status
802 * @return True if the server is a uline OR the string is empty
804 bool ULine(const char* server);
806 /** Returns true if the uline is 'silent' (doesnt generate
807 * remote connect notices etc).
809 bool SilentULine(const char* server);
811 /** Returns the subversion revision ID of this ircd
812 * @return The revision ID or an empty string
814 std::string GetRevision();
816 /** Returns the full version string of this ircd
817 * @return The version string
819 std::string GetVersionString();
821 /** Attempt to write the process id to a given file
822 * @param filename The PID file to attempt to write to
823 * @return This function may bail if the file cannot be written
825 void WritePID(const std::string &filename);
827 /** This constructor initialises all the subsystems and reads the config file.
828 * @param argc The argument count passed to main()
829 * @param argv The argument list passed to main()
830 * @throw <anything> If anything is thrown from here and makes it to
831 * you, you should probably just give up and go home. Yes, really.
832 * It's that bad. Higher level classes should catch any non-fatal exceptions.
834 InspIRCd(int argc, char** argv);
836 /** Send a line of WHOIS data to a user.
837 * @param user user to send the line to
838 * @param dest user being WHOISed
839 * @param numeric Numeric to send
840 * @param text Text of the numeric
842 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
844 /** Send a line of WHOIS data to a user.
845 * @param user user to send the line to
846 * @param dest user being WHOISed
847 * @param numeric Numeric to send
848 * @param format Format string for the numeric
849 * @param ... Parameters for the format string
851 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
853 /** Quit a user for excess flood, and if they are not
854 * fully registered yet, temporarily zline their IP.
855 * @param current user to quit
857 caller1<void, User*> FloodQuitUser;
859 /** Restart the server.
860 * This function will not return. If an error occurs,
861 * it will throw an instance of CoreException.
862 * @param reason The restart reason to show to all clients
863 * @throw CoreException An instance of CoreException indicating the error from execv().
865 void Restart(const std::string &reason);
867 /** Prepare the ircd for restart or shutdown.
868 * This function unloads all modules which can be unloaded,
869 * closes all open sockets, and closes the logfile.
873 /** This copies the user and channel hash_maps into new hash maps.
874 * This frees memory used by the hash_map allocator (which it neglects
875 * to free, most of the time, using tons of ram)
877 void RehashUsersAndChans();
879 /** Resets the cached max bans value on all channels.
884 /** Return a time_t as a human-readable string.
886 std::string TimeString(time_t curtime);
888 /** Begin execution of the server.
889 * NOTE: this function NEVER returns. Internally,
890 * it will repeatedly loop.
891 * @return The return value for this function is undefined.
895 /** Force all BufferedSockets to be removed which are due to
898 void BufferedSocketCull();
900 /** Adds an extban char to the 005 token.
902 void AddExtBanChar(char c);
904 char* GetReadBuffer()
906 return this->ReadBuffer;