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 */
28 // Required system headers.
32 #include "inspircd_config.h"
40 #include "usermanager.h"
43 #include "command_parse.h"
45 #include "socketengine.h"
47 #include "cull_list.h"
48 #include "filelogger.h"
51 #include "configreader.h"
52 #include "inspstring.h"
55 * Used to define the maximum number of parameters a command may have.
57 #define MAXPARAMETERS 127
59 /** Returned by some functions to indicate failure.
63 /** Support for librodent -
64 * see http://www.chatspike.net/index.php?z=64
66 #define ETIREDHAMSTERS EAGAIN
68 /** Template function to convert any input type to std::string
70 template<typename T> inline std::string ConvNumeric(const T &in)
72 if (in == 0) return "0";
77 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
84 std::reverse(res,out);
88 /** Template function to convert any input type to std::string
90 inline std::string ConvToStr(const int in)
92 return ConvNumeric(in);
95 /** Template function to convert any input type to std::string
97 inline std::string ConvToStr(const long in)
99 return ConvNumeric(in);
102 /** Template function to convert any input type to std::string
104 inline std::string ConvToStr(const char* in)
109 /** Template function to convert any input type to std::string
111 inline std::string ConvToStr(const bool in)
113 return (in ? "1" : "0");
116 /** Template function to convert any input type to std::string
118 inline std::string ConvToStr(char in)
120 return std::string(in,1);
123 /** Template function to convert any input type to std::string
125 template <class T> inline std::string ConvToStr(const T &in)
127 std::stringstream tmp;
128 if (!(tmp << in)) return std::string();
132 /** Template function to convert any input type to any other type
133 * (usually an integer or numeric type)
135 template<typename T> inline long ConvToInt(const T &in)
137 std::stringstream tmp;
138 if (!(tmp << in)) return 0;
139 return atoi(tmp.str().c_str());
142 /** Template function to convert integer to char, storing result in *res and
143 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
144 * @param T input value
145 * @param V result value
146 * @param R base to convert to
148 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
150 if (base < 2 || base > 16) { *res = 0; return res; }
154 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
158 if ( in < 0 && base == 10) *out++ = '-';
159 std::reverse( res, out );
164 /** This class contains various STATS counters
165 * It is used by the InspIRCd class, which internally
166 * has an instance of it.
168 class serverstats : public classbase
171 /** Number of accepted connections
173 unsigned long statsAccept;
174 /** Number of failed accepts
176 unsigned long statsRefused;
177 /** Number of unknown commands seen
179 unsigned long statsUnknown;
180 /** Number of nickname collisions handled
182 unsigned long statsCollisions;
183 /** Number of DNS queries sent out
185 unsigned long statsDns;
186 /** Number of good DNS replies received
187 * NOTE: This may not tally to the number sent out,
188 * due to timeouts and other latency issues.
190 unsigned long statsDnsGood;
191 /** Number of bad (negative) DNS replies received
192 * NOTE: This may not tally to the number sent out,
193 * due to timeouts and other latency issues.
195 unsigned long statsDnsBad;
196 /** Number of inbound connections seen
198 unsigned long statsConnects;
199 /** Total bytes of data transmitted
202 /** Total bytes of data received
205 /** Cpu usage at last sample
208 /** Time last sample was read
211 /** The constructor initializes all the counts to zero
214 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
215 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
220 /** A list of failed port bindings, used for informational purposes on startup */
221 typedef std::vector<std::pair<std::string, long> > FailedPortList;
225 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
226 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
227 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
228 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
229 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
231 /* Forward declaration - required */
233 class BanCacheManager;
235 class ConfigReaderThread : public Thread
237 InspIRCd* ServerInstance;
239 ConfigReaderThread(InspIRCd* Instance) : Thread(), ServerInstance(Instance)
243 virtual ~ConfigReaderThread()
250 /** The main class of the irc server.
251 * This class contains instances of all the other classes
252 * in this software, with the exception of the base class,
253 * classbase. Amongst other things, it contains a ModeParser,
254 * a DNS object, a CommandParser object, and a list of active
255 * Module objects, and facilities for Module objects to
256 * interact with the core system it implements. You should
257 * NEVER attempt to instantiate a class of type InspIRCd
258 * yourself. If you do, this is equivalent to spawning a second
259 * IRC server, and could have catastrophic consequences for the
260 * program in terms of ram usage (basically, you could create
261 * an obese forkbomb built from recursively spawning irc servers!)
263 class CoreExport InspIRCd : public classbase
266 /** Holds the current UID. Used to generate the next one.
268 char current_uid[UUID_LENGTH];
270 /** Set up the signal handlers
274 /** Daemonize the ircd and close standard input/output streams
275 * @return True if the program daemonized succesfully
279 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
280 * @param TIME the current time
282 void DoSocketTimeouts(time_t TIME);
284 /** Sets up UID subsystem
286 void InitialiseUID();
288 /** Perform background user events such as PING checks
290 void DoBackgroundUserStuff();
292 /** Returns true when all modules have done pre-registration checks on a user
293 * @param user The user to verify
294 * @return True if all modules have finished checking this user
296 bool AllModulesReportReady(User* user);
298 /** Logfile pathname specified on the commandline, or empty string
300 char LogFileName[MAXBUF];
302 /** The current time, updated in the mainloop
306 /** The time that was recorded last time around the mainloop
310 /** A 64k buffer used to read client lines into
312 char ReadBuffer[65535];
314 /** Used when connecting clients
316 irc::sockets::insp_sockaddr client, server;
318 /** Used when connecting clients
328 /** Global cull list, will be processed on next iteration
330 CullList GlobalCulls;
334 ProcessUserHandler HandleProcessUser;
335 IsNickHandler HandleIsNick;
336 IsIdentHandler HandleIsIdent;
337 FindDescriptorHandler HandleFindDescriptor;
338 FloodQuitUserHandler HandleFloodQuitUser;
340 /** BufferedSocket classes pending deletion after being closed.
341 * We don't delete these immediately as this may cause a segmentation fault.
343 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
345 /** 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
348 * SendMode expects a User* to send the numeric replies
349 * back to, so we create it a fake user that isnt in the user
350 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
351 * falls into the abyss :p
355 /** Returns the next available UID for this server.
357 std::string GetUID();
359 /** Find a user in the UUID hash
360 * @param nick The nickname to find
361 * @return A pointer to the user, or NULL if the user does not exist
363 User *FindUUID(const std::string &);
365 /** Find a user in the UUID hash
366 * @param nick The nickname to find
367 * @return A pointer to the user, or NULL if the user does not exist
369 User *FindUUID(const char *);
371 /** Build the ISUPPORT string by triggering all modules On005Numeric events
373 void BuildISupport();
375 /** List of server names we've seen.
377 servernamelist servernames;
379 /** Time this ircd was booted
383 /** Config file pathname specified on the commandline or via ./configure
385 char ConfigFileName[MAXBUF];
387 /** Mode handler, handles mode setting and removal
391 /** Command parser, handles client to server commands
393 CommandParser* Parser;
395 /** Socket engine, handles socket activity events
399 /** Thread engine, Handles threading where required
401 ThreadEngine* Threads;
403 /** The thread/class used to read config files in REHASH and on startup
405 ConfigReaderThread* ConfigThread;
407 /** LogManager handles logging.
411 /** ModuleManager contains everything related to loading/unloading
414 ModuleManager* Modules;
416 /** BanCacheManager is used to speed up checking of restrictions on connection
419 BanCacheManager *BanCache;
421 /** Stats class, holds miscellaneous stats counters
425 /** Server Config class, holds configuration file data
427 ServerConfig* Config;
429 /** Snomask manager - handles routing of snomask messages
434 /** DNS class, provides resolver facilities to the core and modules
438 /** Timer manager class, triggers Timer timer events
440 TimerManager* Timers;
442 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
444 XLineManager* XLines;
446 /** User manager. Various methods and data associated with users.
450 /** Channel list, a hash_map containing all channels XXX move to channel manager class
454 /** Set to the current signal recieved
458 /** Get the current time
459 * Because this only calls time() once every time around the mainloop,
460 * it is much faster than calling time() directly.
461 * @return The current time as an epoch value (time_t)
465 /** Process a user whos socket has been flagged as active
466 * @param cu The user to process
467 * @return There is no actual return value, however upon exit, the user 'cu' may have been
468 * marked for deletion in the global CullList.
470 caller1<void, User*> ProcessUser;
472 /** Bind all ports specified in the configuration file.
473 * @param bail True if the function should bail back to the shell on failure
474 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
475 * @return The number of ports actually bound without error
477 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
479 /** Binds a socket on an already open file descriptor
480 * @param sockfd A valid file descriptor of an open socket
481 * @param port The port number to bind to
482 * @param addr The address to bind to (IP only)
483 * @return True if the port was bound successfully
485 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
487 /** Adds a server name to the list of servers we've seen
488 * @param The servername to add
490 void AddServerName(const std::string &servername);
492 /** Finds a cached char* pointer of a server name,
493 * This is used to optimize User by storing only the pointer to the name
494 * @param The servername to find
495 * @return A pointer to this name, gauranteed to never become invalid
497 const char* FindServerNamePtr(const std::string &servername);
499 /** Returns true if we've seen the given server name before
500 * @param The servername to find
501 * @return True if we've seen this server name before
503 bool FindServerName(const std::string &servername);
505 /** Gets the GECOS (description) field of the given server.
506 * If the servername is not that of the local server, the name
507 * is passed to handling modules which will attempt to determine
508 * the GECOS that bleongs to the given servername.
509 * @param servername The servername to find the description of
510 * @return The description of this server, or of the local server
512 std::string GetServerDescription(const char* servername);
514 /** Find a user in the nick hash.
515 * If the user cant be found in the nick hash check the uuid hash
516 * @param nick The nickname to find
517 * @return A pointer to the user, or NULL if the user does not exist
519 User* FindNick(const std::string &nick);
521 /** Find a user in the nick hash.
522 * If the user cant be found in the nick hash check the uuid hash
523 * @param nick The nickname to find
524 * @return A pointer to the user, or NULL if the user does not exist
526 User* FindNick(const char* nick);
528 /** Find a user in the nick hash ONLY
530 User* FindNickOnly(const char* nick);
532 /** Find a user in the nick hash ONLY
534 User* FindNickOnly(const std::string &nick);
536 /** Find a channel in the channels hash
537 * @param chan The channel to find
538 * @return A pointer to the channel, or NULL if the channel does not exist
540 Channel* FindChan(const std::string &chan);
542 /** Find a channel in the channels hash
543 * @param chan The channel to find
544 * @return A pointer to the channel, or NULL if the channel does not exist
546 Channel* FindChan(const char* chan);
548 /** Check for a 'die' tag in the config file, and abort if found
549 * @return Depending on the configuration, this function may never return
553 /** Check we aren't running as root, and exit if we are
554 * @return Depending on the configuration, this function may never return
558 /** Determine the right path for, and open, the logfile
559 * @param argv The argv passed to main() initially, used to calculate program path
560 * @param argc The argc passed to main() initially, used to calculate program path
561 * @return True if the log could be opened, false if otherwise
563 bool OpenLog(char** argv, int argc);
565 /** Return true if a channel name is valid
566 * @param chname A channel name to verify
567 * @return True if the name is valid
569 bool IsChannel(const char *chname);
571 /** Return true if str looks like a server ID
572 * @param string to check against
574 bool IsSID(const std::string &str);
576 /** Rehash the local server
580 /** Handles incoming signals after being set
581 * @param signal the signal recieved
583 void SignalHandler(int signal);
585 /** Sets the signal recieved
586 * @param signal the signal recieved
588 static void SetSignal(int signal);
590 /** Causes the server to exit after unloading modules and
591 * closing all open file descriptors.
593 * @param The exit code to give to the operating system
594 * (See the ExitStatus enum for valid values)
596 void Exit(int status);
598 /** Causes the server to exit immediately with exit code 0.
599 * The status code is required for signal handlers, and ignored.
601 static void QuickExit(int status);
603 /** Return a count of channels on the network
604 * @return The number of channels
608 /** Send an error notice to all local users, opered and unopered
609 * @param s The error string to send
611 void SendError(const std::string &s);
613 /** Return true if a nickname is valid
614 * @param n A nickname to verify
615 * @return True if the nick is valid
617 caller1<bool, const char*> IsNick;
619 /** Return true if an ident is valid
620 * @param An ident to verify
621 * @return True if the ident is valid
623 caller1<bool, const char*> IsIdent;
625 /** Find a username by their file descriptor.
626 * It is preferred to use this over directly accessing the fd_ref_table array.
627 * @param socket The file descriptor of a user
628 * @return A pointer to the user if the user exists locally on this descriptor
630 caller1<User*, int> FindDescriptor;
632 /** Add a dns Resolver class to this server's active set
633 * @param r The resolver to add
634 * @param cached If this value is true, then the cache will
635 * be searched for the DNS result, immediately. If the value is
636 * false, then a request will be sent to the nameserver, and the
637 * result will not be immediately available. You should usually
638 * use the boolean value which you passed to the Resolver
639 * constructor, which Resolver will set appropriately depending
640 * on if cached results are available and haven't expired. It is
641 * however safe to force this value to false, forcing a remote DNS
642 * lookup, but not an update of the cache.
643 * @return True if the operation completed successfully. Note that
644 * if this method returns true, you should not attempt to access
645 * the resolver class you pass it after this call, as depending upon
646 * the request given, the object may be deleted!
648 bool AddResolver(Resolver* r, bool cached);
650 /** Add a command to this server's command parser
651 * @param f A Command command handler object to add
652 * @throw ModuleException Will throw ModuleExcption if the command already exists
654 void AddCommand(Command *f);
656 /** Send a modechange.
657 * The parameters provided are identical to that sent to the
658 * handler for class cmd_mode.
659 * @param parameters The mode parameters
660 * @param pcnt The number of items you have given in the first parameter
661 * @param user The user to send error messages to
663 void SendMode(const char* const* parameters, int pcnt, User *user);
665 /** Match two strings using pattern matching.
666 * This operates identically to the global function match(),
667 * except for that it takes std::string arguments rather than
669 * @param sliteral The literal string to match against
670 * @param spattern The pattern to match against. CIDR and globs are supported.
672 bool MatchText(const std::string &sliteral, const std::string &spattern);
674 /** Call the handler for a given command.
675 * @param commandname The command whos handler you wish to call
676 * @param parameters The mode parameters
677 * @param pcnt The number of items you have given in the first parameter
678 * @param user The user to execute the command as
679 * @return True if the command handler was called successfully
681 CmdResult CallCommandHandler(const std::string &commandname, const char* const* parameters, int pcnt, User* user);
683 /** Return true if the command is a module-implemented command and the given parameters are valid for it
684 * @param parameters The mode parameters
685 * @param pcnt The number of items you have given in the first parameter
686 * @param user The user to test-execute the command as
687 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
689 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
691 /** Return true if the given parameter is a valid nick!user\@host mask
692 * @param mask A nick!user\@host masak to match against
693 * @return True i the mask is valid
695 bool IsValidMask(const std::string &mask);
697 /** Rehash the local server
701 /** Return the channel whos index number matches that provided
702 * @param The index number of the channel to fetch
703 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
705 Channel* GetChannelIndex(long index);
707 /** Dump text to a user target, splitting it appropriately to fit
708 * @param User the user to dump the text to
709 * @param LinePrefix text to prefix each complete line with
710 * @param TextStream the text to send to the user
712 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
714 /** Check if the given nickmask matches too many users, send errors to the given user
715 * @param nick A nickmask to match against
716 * @param user A user to send error text to
717 * @return True if the nick matches too many users
719 bool NickMatchesEveryone(const std::string &nick, User* user);
721 /** Check if the given IP mask matches too many users, send errors to the given user
722 * @param ip An ipmask to match against
723 * @param user A user to send error text to
724 * @return True if the ip matches too many users
726 bool IPMatchesEveryone(const std::string &ip, User* user);
728 /** Check if the given hostmask matches too many users, send errors to the given user
729 * @param mask A hostmask to match against
730 * @param user A user to send error text to
731 * @return True if the host matches too many users
733 bool HostMatchesEveryone(const std::string &mask, User* user);
735 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
736 * @param str A string containing a time in the form 1y2w3d4h6m5s
737 * (one year, two weeks, three days, four hours, six minutes and five seconds)
738 * @return The total number of seconds
740 long Duration(const std::string &str);
742 /** Attempt to compare a password to a string from the config file.
743 * This will be passed to handling modules which will compare the data
744 * against possible hashed equivalents in the input string.
745 * @param ex The object (user, server, whatever) causing the comparison.
746 * @param data The data from the config file
747 * @param input The data input by the oper
748 * @param hashtype The hash from the config file
749 * @return 0 if the strings match, 1 or -1 if they do not
751 int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
753 /** Check if a given server is a uline.
754 * An empty string returns true, this is by design.
755 * @param server The server to check for uline status
756 * @return True if the server is a uline OR the string is empty
758 bool ULine(const char* server);
760 /** Returns true if the uline is 'silent' (doesnt generate
761 * remote connect notices etc).
763 bool SilentULine(const char* server);
765 /** Returns the subversion revision ID of this ircd
766 * @return The revision ID or an empty string
768 std::string GetRevision();
770 /** Returns the full version string of this ircd
771 * @return The version string
773 std::string GetVersionString();
775 /** Attempt to write the process id to a given file
776 * @param filename The PID file to attempt to write to
777 * @return This function may bail if the file cannot be written
779 void WritePID(const std::string &filename);
781 /** This constructor initialises all the subsystems and reads the config file.
782 * @param argc The argument count passed to main()
783 * @param argv The argument list passed to main()
784 * @throw <anything> If anything is thrown from here and makes it to
785 * you, you should probably just give up and go home. Yes, really.
786 * It's that bad. Higher level classes should catch any non-fatal exceptions.
788 InspIRCd(int argc, char** argv);
790 /** Output a log message to the ircd.log file
791 * The text will only be output if the current loglevel
792 * is less than or equal to the level you provide
793 * @param level A log level from the DebugLevel enum
794 * @param text Format string of to write to the log
795 * @param ... Format arguments of text to write to the log
797 void Log(int level, const char* text, ...);
799 /** Output a log message to the ircd.log file
800 * The text will only be output if the current loglevel
801 * is less than or equal to the level you provide
802 * @param level A log level from the DebugLevel enum
803 * @param text Text to write to the log
805 void Log(int level, const std::string &text);
807 /** Send a line of WHOIS data to a user.
808 * @param user user to send the line to
809 * @param dest user being WHOISed
810 * @param numeric Numeric to send
811 * @param text Text of the numeric
813 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
815 /** Send a line of WHOIS data to a user.
816 * @param user user to send the line to
817 * @param dest user being WHOISed
818 * @param numeric Numeric to send
819 * @param format Format string for the numeric
820 * @param ... Parameters for the format string
822 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
824 /** Quit a user for excess flood, and if they are not
825 * fully registered yet, temporarily zline their IP.
826 * @param current user to quit
828 caller1<void, User*> FloodQuitUser;
830 /** Restart the server.
831 * This function will not return. If an error occurs,
832 * it will throw an instance of CoreException.
833 * @param reason The restart reason to show to all clients
834 * @throw CoreException An instance of CoreException indicating the error from execv().
836 void Restart(const std::string &reason);
838 /** Prepare the ircd for restart or shutdown.
839 * This function unloads all modules which can be unloaded,
840 * closes all open sockets, and closes the logfile.
844 /** This copies the user and channel hash_maps into new hash maps.
845 * This frees memory used by the hash_map allocator (which it neglects
846 * to free, most of the time, using tons of ram)
848 void RehashUsersAndChans();
850 /** Resets the cached max bans value on all channels.
855 /** Return a time_t as a human-readable string.
857 std::string TimeString(time_t curtime);
859 /** Begin execution of the server.
860 * NOTE: this function NEVER returns. Internally,
861 * it will repeatedly loop.
862 * @return The return value for this function is undefined.
866 /** Force all BufferedSockets to be removed which are due to
869 void BufferedSocketCull();
871 char* GetReadBuffer()
873 return this->ReadBuffer;