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.
42 #include "inspircd_config.h"
50 #include "usermanager.h"
53 #include "command_parse.h"
55 #include "socketengine.h"
57 #include "cull_list.h"
58 #include "filelogger.h"
61 #include "configreader.h"
62 #include "inspstring.h"
66 #warning Potentially broken system, PATH_MAX undefined
71 * Used to define the maximum number of parameters a command may have.
73 #define MAXPARAMETERS 127
75 /** Returned by some functions to indicate failure.
79 /** Support for librodent -
80 * see http://www.chatspike.net/index.php?z=64
82 #define ETIREDHAMSTERS EAGAIN
84 /** Template function to convert any input type to std::string
86 template<typename T> inline std::string ConvNumeric(const T &in)
88 if (in == 0) return "0";
93 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
100 std::reverse(res,out);
104 /** Template function to convert any input type to std::string
106 inline std::string ConvToStr(const int in)
108 return ConvNumeric(in);
111 /** Template function to convert any input type to std::string
113 inline std::string ConvToStr(const long in)
115 return ConvNumeric(in);
118 /** Template function to convert any input type to std::string
120 inline std::string ConvToStr(const char* in)
125 /** Template function to convert any input type to std::string
127 inline std::string ConvToStr(const bool in)
129 return (in ? "1" : "0");
132 /** Template function to convert any input type to std::string
134 inline std::string ConvToStr(char in)
136 return std::string(in,1);
139 /** Template function to convert any input type to std::string
141 template <class T> inline std::string ConvToStr(const T &in)
143 std::stringstream tmp;
144 if (!(tmp << in)) return std::string();
148 /** Template function to convert any input type to any other type
149 * (usually an integer or numeric type)
151 template<typename T> inline long ConvToInt(const T &in)
153 std::stringstream tmp;
154 if (!(tmp << in)) return 0;
155 return atoi(tmp.str().c_str());
158 /** Template function to convert integer to char, storing result in *res and
159 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
160 * @param T input value
161 * @param V result value
162 * @param R base to convert to
164 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
166 if (base < 2 || base > 16) { *res = 0; return res; }
170 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
174 if ( in < 0 && base == 10) *out++ = '-';
175 std::reverse( res, out );
180 /** This class contains various STATS counters
181 * It is used by the InspIRCd class, which internally
182 * has an instance of it.
184 class serverstats : public classbase
187 /** Number of accepted connections
189 unsigned long statsAccept;
190 /** Number of failed accepts
192 unsigned long statsRefused;
193 /** Number of unknown commands seen
195 unsigned long statsUnknown;
196 /** Number of nickname collisions handled
198 unsigned long statsCollisions;
199 /** Number of DNS queries sent out
201 unsigned long statsDns;
202 /** Number of good DNS replies received
203 * NOTE: This may not tally to the number sent out,
204 * due to timeouts and other latency issues.
206 unsigned long statsDnsGood;
207 /** Number of bad (negative) DNS replies received
208 * NOTE: This may not tally to the number sent out,
209 * due to timeouts and other latency issues.
211 unsigned long statsDnsBad;
212 /** Number of inbound connections seen
214 unsigned long statsConnects;
215 /** Total bytes of data transmitted
218 /** Total bytes of data received
221 /** Cpu usage at last sample
224 /** Time last sample was read
227 /** The constructor initializes all the counts to zero
230 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
231 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
236 /** A list of failed port bindings, used for informational purposes on startup */
237 typedef std::vector<std::pair<std::string, long> > FailedPortList;
241 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
242 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
243 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
244 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
245 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
246 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
247 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
248 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
250 /* Forward declaration - required */
252 class BanCacheManager;
254 class CoreExport ConfigReaderThread : public Thread
256 InspIRCd* ServerInstance;
260 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
264 virtual ~ConfigReaderThread()
271 /** The main class of the irc server.
272 * This class contains instances of all the other classes
273 * in this software, with the exception of the base class,
274 * classbase. Amongst other things, it contains a ModeParser,
275 * a DNS object, a CommandParser object, and a list of active
276 * Module objects, and facilities for Module objects to
277 * interact with the core system it implements.
279 class CoreExport InspIRCd : public classbase
282 /** Holds the current UID. Used to generate the next one.
284 char current_uid[UUID_LENGTH];
286 /** Set up the signal handlers
290 /** Daemonize the ircd and close standard input/output streams
291 * @return True if the program daemonized succesfully
295 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
296 * @param TIME the current time
298 void DoSocketTimeouts(time_t TIME);
300 /** Increments the current UID by one.
302 void IncrementUID(int pos);
304 /** Perform background user events such as PING checks
306 void DoBackgroundUserStuff();
308 /** Returns true when all modules have done pre-registration checks on a user
309 * @param user The user to verify
310 * @return True if all modules have finished checking this user
312 bool AllModulesReportReady(User* user);
314 /** Logfile pathname specified on the commandline, or empty string
316 char LogFileName[MAXBUF];
318 /** The current time, updated in the mainloop
322 /** The time that was recorded last time around the mainloop
326 /** A 64k buffer used to read client lines into
328 char ReadBuffer[65535];
330 /** Used when connecting clients
332 irc::sockets::insp_sockaddr client, server;
334 /** Used when connecting clients
344 /** Global cull list, will be processed on next iteration
346 CullList GlobalCulls;
350 ProcessUserHandler HandleProcessUser;
351 IsNickHandler HandleIsNick;
352 IsIdentHandler HandleIsIdent;
353 FindDescriptorHandler HandleFindDescriptor;
354 FloodQuitUserHandler HandleFloodQuitUser;
355 IsChannelHandler HandleIsChannel;
356 IsSIDHandler HandleIsSID;
357 RehashHandler HandleRehash;
359 /** BufferedSocket classes pending deletion after being closed.
360 * We don't delete these immediately as this may cause a segmentation fault.
362 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
364 /** 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
367 * SendMode expects a User* to send the numeric replies
368 * back to, so we create it a fake user that isnt in the user
369 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
370 * falls into the abyss :p
374 /** Returns the next available UID for this server.
376 std::string GetUID();
378 /** Find a user in the UUID hash
379 * @param nick The nickname to find
380 * @return A pointer to the user, or NULL if the user does not exist
382 User *FindUUID(const std::string &);
384 /** Find a user in the UUID hash
385 * @param nick The nickname to find
386 * @return A pointer to the user, or NULL if the user does not exist
388 User *FindUUID(const char *);
390 /** Build the ISUPPORT string by triggering all modules On005Numeric events
392 void BuildISupport();
394 /** List of server names we've seen.
396 servernamelist servernames;
398 /** Time this ircd was booted
402 /** Config file pathname specified on the commandline or via ./configure
404 char ConfigFileName[MAXBUF];
406 /** Mode handler, handles mode setting and removal
410 /** Command parser, handles client to server commands
412 CommandParser* Parser;
414 /** Socket engine, handles socket activity events
418 /** Thread engine, Handles threading where required
420 ThreadEngine* Threads;
422 /** The thread/class used to read config files in REHASH and on startup
424 ConfigReaderThread* ConfigThread;
426 /** LogManager handles logging.
430 /** ModuleManager contains everything related to loading/unloading
433 ModuleManager* Modules;
435 /** BanCacheManager is used to speed up checking of restrictions on connection
438 BanCacheManager *BanCache;
440 /** Stats class, holds miscellaneous stats counters
444 /** Server Config class, holds configuration file data
446 ServerConfig* Config;
448 /** Snomask manager - handles routing of snomask messages
453 /** DNS class, provides resolver facilities to the core and modules
457 /** Timer manager class, triggers Timer timer events
459 TimerManager* Timers;
461 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
463 XLineManager* XLines;
465 /** User manager. Various methods and data associated with users.
469 /** Channel list, a hash_map containing all channels XXX move to channel manager class
473 /** Set to the current signal recieved
477 /** Protocol interface, overridden by server protocol modules
479 ProtocolInterface* PI;
481 /** Get the current time
482 * Because this only calls time() once every time around the mainloop,
483 * it is much faster than calling time() directly.
484 * @return The current time as an epoch value (time_t)
488 /** Process a user whos socket has been flagged as active
489 * @param cu The user to process
490 * @return There is no actual return value, however upon exit, the user 'cu' may have been
491 * marked for deletion in the global CullList.
493 caller1<void, User*> ProcessUser;
495 /** Bind all ports specified in the configuration file.
496 * @param bail True if the function should bail back to the shell on failure
497 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
498 * @return The number of ports actually bound without error
500 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
502 /** Binds a socket on an already open file descriptor
503 * @param sockfd A valid file descriptor of an open socket
504 * @param port The port number to bind to
505 * @param addr The address to bind to (IP only)
506 * @return True if the port was bound successfully
508 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
510 /** Adds a server name to the list of servers we've seen
511 * @param The servername to add
513 void AddServerName(const std::string &servername);
515 /** Finds a cached char* pointer of a server name,
516 * This is used to optimize User by storing only the pointer to the name
517 * @param The servername to find
518 * @return A pointer to this name, gauranteed to never become invalid
520 const char* FindServerNamePtr(const std::string &servername);
522 /** Returns true if we've seen the given server name before
523 * @param The servername to find
524 * @return True if we've seen this server name before
526 bool FindServerName(const std::string &servername);
528 /** Gets the GECOS (description) field of the given server.
529 * If the servername is not that of the local server, the name
530 * is passed to handling modules which will attempt to determine
531 * the GECOS that bleongs to the given servername.
532 * @param servername The servername to find the description of
533 * @return The description of this server, or of the local server
535 std::string GetServerDescription(const char* servername);
537 /** Find a user in the nick hash.
538 * If the user cant be found in the nick hash check the uuid hash
539 * @param nick The nickname to find
540 * @return A pointer to the user, or NULL if the user does not exist
542 User* FindNick(const std::string &nick);
544 /** Find a user in the nick hash.
545 * If the user cant be found in the nick hash check the uuid hash
546 * @param nick The nickname to find
547 * @return A pointer to the user, or NULL if the user does not exist
549 User* FindNick(const char* nick);
551 /** Find a user in the nick hash ONLY
553 User* FindNickOnly(const char* nick);
555 /** Find a user in the nick hash ONLY
557 User* FindNickOnly(const std::string &nick);
559 /** Find a channel in the channels hash
560 * @param chan The channel to find
561 * @return A pointer to the channel, or NULL if the channel does not exist
563 Channel* FindChan(const std::string &chan);
565 /** Find a channel in the channels hash
566 * @param chan The channel to find
567 * @return A pointer to the channel, or NULL if the channel does not exist
569 Channel* FindChan(const char* chan);
571 /** Check for a 'die' tag in the config file, and abort if found
572 * @return Depending on the configuration, this function may never return
576 /** Check we aren't running as root, and exit if we are
577 * @return Depending on the configuration, this function may never return
581 /** Determine the right path for, and open, the logfile
582 * @param argv The argv passed to main() initially, used to calculate program path
583 * @param argc The argc passed to main() initially, used to calculate program path
584 * @return True if the log could be opened, false if otherwise
586 bool OpenLog(char** argv, int argc);
588 /** Return true if a channel name is valid
589 * @param chname A channel name to verify
590 * @return True if the name is valid
592 caller2<bool, const char*, size_t> IsChannel;
594 /** Return true if str looks like a server ID
595 * @param string to check against
597 caller1<bool, const std::string&> IsSID;
599 /** Rehash the local server
601 caller1<void, const std::string&> Rehash;
603 /** Handles incoming signals after being set
604 * @param signal the signal recieved
606 void SignalHandler(int signal);
608 /** Sets the signal recieved
609 * @param signal the signal recieved
611 static void SetSignal(int signal);
613 /** Causes the server to exit after unloading modules and
614 * closing all open file descriptors.
616 * @param The exit code to give to the operating system
617 * (See the ExitStatus enum for valid values)
619 void Exit(int status);
621 /** Causes the server to exit immediately with exit code 0.
622 * The status code is required for signal handlers, and ignored.
624 static void QuickExit(int status);
626 /** Return a count of channels on the network
627 * @return The number of channels
631 /** Send an error notice to all local users, opered and unopered
632 * @param s The error string to send
634 void SendError(const std::string &s);
636 /** Return true if a nickname is valid
637 * @param n A nickname to verify
638 * @return True if the nick is valid
640 caller2<bool, const char*, size_t> IsNick;
642 /** Return true if an ident is valid
643 * @param An ident to verify
644 * @return True if the ident is valid
646 caller1<bool, const char*> IsIdent;
648 /** Find a username by their file descriptor.
649 * It is preferred to use this over directly accessing the fd_ref_table array.
650 * @param socket The file descriptor of a user
651 * @return A pointer to the user if the user exists locally on this descriptor
653 caller1<User*, int> FindDescriptor;
655 /** Add a dns Resolver class to this server's active set
656 * @param r The resolver to add
657 * @param cached If this value is true, then the cache will
658 * be searched for the DNS result, immediately. If the value is
659 * false, then a request will be sent to the nameserver, and the
660 * result will not be immediately available. You should usually
661 * use the boolean value which you passed to the Resolver
662 * constructor, which Resolver will set appropriately depending
663 * on if cached results are available and haven't expired. It is
664 * however safe to force this value to false, forcing a remote DNS
665 * lookup, but not an update of the cache.
666 * @return True if the operation completed successfully. Note that
667 * if this method returns true, you should not attempt to access
668 * the resolver class you pass it after this call, as depending upon
669 * the request given, the object may be deleted!
671 bool AddResolver(Resolver* r, bool cached);
673 /** Add a command to this server's command parser
674 * @param f A Command command handler object to add
675 * @throw ModuleException Will throw ModuleExcption if the command already exists
677 void AddCommand(Command *f);
679 /** Send a modechange.
680 * The parameters provided are identical to that sent to the
681 * handler for class cmd_mode.
682 * @param parameters The mode parameters
683 * @param pcnt The number of items you have given in the first parameter
684 * @param user The user to send error messages to
686 void SendMode(const std::vector<std::string>& parameters, User *user);
688 /** Match two strings using pattern matching.
689 * This operates identically to the global function match(),
690 * except for that it takes std::string arguments rather than
692 * @param sliteral The literal string to match against
693 * @param spattern The pattern to match against. CIDR and globs are supported.
695 bool MatchText(const std::string &sliteral, const std::string &spattern);
697 /** Call the handler for a given command.
698 * @param commandname The command whos handler you wish to call
699 * @param parameters The mode parameters
700 * @param pcnt The number of items you have given in the first parameter
701 * @param user The user to execute the command as
702 * @return True if the command handler was called successfully
704 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
706 /** Return true if the command is a module-implemented command and the given parameters are valid for it
707 * @param parameters The mode parameters
708 * @param pcnt The number of items you have given in the first parameter
709 * @param user The user to test-execute the command as
710 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
712 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
714 /** Return true if the given parameter is a valid nick!user\@host mask
715 * @param mask A nick!user\@host masak to match against
716 * @return True i the mask is valid
718 bool IsValidMask(const std::string &mask);
720 /** Rehash the local server
724 /** Return the channel whos index number matches that provided
725 * @param The index number of the channel to fetch
726 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
728 Channel* GetChannelIndex(long index);
730 /** Dump text to a user target, splitting it appropriately to fit
731 * @param User the user to dump the text to
732 * @param LinePrefix text to prefix each complete line with
733 * @param TextStream the text to send to the user
735 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
737 /** Check if the given nickmask matches too many users, send errors to the given user
738 * @param nick A nickmask to match against
739 * @param user A user to send error text to
740 * @return True if the nick matches too many users
742 bool NickMatchesEveryone(const std::string &nick, User* user);
744 /** Check if the given IP mask matches too many users, send errors to the given user
745 * @param ip An ipmask to match against
746 * @param user A user to send error text to
747 * @return True if the ip matches too many users
749 bool IPMatchesEveryone(const std::string &ip, User* user);
751 /** Check if the given hostmask matches too many users, send errors to the given user
752 * @param mask A hostmask to match against
753 * @param user A user to send error text to
754 * @return True if the host matches too many users
756 bool HostMatchesEveryone(const std::string &mask, User* user);
758 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
759 * @param str A string containing a time in the form 1y2w3d4h6m5s
760 * (one year, two weeks, three days, four hours, six minutes and five seconds)
761 * @return The total number of seconds
763 long Duration(const std::string &str);
765 /** Attempt to compare a password to a string from the config file.
766 * This will be passed to handling modules which will compare the data
767 * against possible hashed equivalents in the input string.
768 * @param ex The object (user, server, whatever) causing the comparison.
769 * @param data The data from the config file
770 * @param input The data input by the oper
771 * @param hashtype The hash from the config file
772 * @return 0 if the strings match, 1 or -1 if they do not
774 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
776 /** Check if a given server is a uline.
777 * An empty string returns true, this is by design.
778 * @param server The server to check for uline status
779 * @return True if the server is a uline OR the string is empty
781 bool ULine(const char* server);
783 /** Returns true if the uline is 'silent' (doesnt generate
784 * remote connect notices etc).
786 bool SilentULine(const char* server);
788 /** Returns the subversion revision ID of this ircd
789 * @return The revision ID or an empty string
791 std::string GetRevision();
793 /** Returns the full version string of this ircd
794 * @return The version string
796 std::string GetVersionString();
798 /** Attempt to write the process id to a given file
799 * @param filename The PID file to attempt to write to
800 * @return This function may bail if the file cannot be written
802 void WritePID(const std::string &filename);
804 /** This constructor initialises all the subsystems and reads the config file.
805 * @param argc The argument count passed to main()
806 * @param argv The argument list passed to main()
807 * @throw <anything> If anything is thrown from here and makes it to
808 * you, you should probably just give up and go home. Yes, really.
809 * It's that bad. Higher level classes should catch any non-fatal exceptions.
811 InspIRCd(int argc, char** argv);
813 /** Send a line of WHOIS data to a user.
814 * @param user user to send the line to
815 * @param dest user being WHOISed
816 * @param numeric Numeric to send
817 * @param text Text of the numeric
819 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
821 /** Send a line of WHOIS data to a user.
822 * @param user user to send the line to
823 * @param dest user being WHOISed
824 * @param numeric Numeric to send
825 * @param format Format string for the numeric
826 * @param ... Parameters for the format string
828 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
830 /** Quit a user for excess flood, and if they are not
831 * fully registered yet, temporarily zline their IP.
832 * @param current user to quit
834 caller1<void, User*> FloodQuitUser;
836 /** Restart the server.
837 * This function will not return. If an error occurs,
838 * it will throw an instance of CoreException.
839 * @param reason The restart reason to show to all clients
840 * @throw CoreException An instance of CoreException indicating the error from execv().
842 void Restart(const std::string &reason);
844 /** Prepare the ircd for restart or shutdown.
845 * This function unloads all modules which can be unloaded,
846 * closes all open sockets, and closes the logfile.
850 /** This copies the user and channel hash_maps into new hash maps.
851 * This frees memory used by the hash_map allocator (which it neglects
852 * to free, most of the time, using tons of ram)
854 void RehashUsersAndChans();
856 /** Resets the cached max bans value on all channels.
861 /** Return a time_t as a human-readable string.
863 std::string TimeString(time_t curtime);
865 /** Begin execution of the server.
866 * NOTE: this function NEVER returns. Internally,
867 * it will repeatedly loop.
868 * @return The return value for this function is undefined.
872 /** Force all BufferedSockets to be removed which are due to
875 void BufferedSocketCull();
877 char* GetReadBuffer()
879 return this->ReadBuffer;