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.
35 #include "inspircd_config.h"
41 #include "usermanager.h"
44 #include "socketengine.h"
45 #include "command_parse.h"
47 #include "cull_list.h"
48 #include "filelogger.h"
52 * Used to define the maximum number of parameters a command may have.
54 #define MAXPARAMETERS 127
56 /** Returned by some functions to indicate failure.
60 /** Support for librodent -
61 * see http://www.chatspike.net/index.php?z=64
63 #define ETIREDHAMSTERS EAGAIN
65 /** Template function to convert any input type to std::string
67 template<typename T> inline std::string ConvNumeric(const T &in)
69 if (in == 0) return "0";
74 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
81 std::reverse(res,out);
85 /** Template function to convert any input type to std::string
87 inline std::string ConvToStr(const int in)
89 return ConvNumeric(in);
92 /** Template function to convert any input type to std::string
94 inline std::string ConvToStr(const long in)
96 return ConvNumeric(in);
99 /** Template function to convert any input type to std::string
101 inline std::string ConvToStr(const char* in)
106 /** Template function to convert any input type to std::string
108 inline std::string ConvToStr(const bool in)
110 return (in ? "1" : "0");
113 /** Template function to convert any input type to std::string
115 inline std::string ConvToStr(char in)
117 return std::string(in,1);
120 /** Template function to convert any input type to std::string
122 template <class T> inline std::string ConvToStr(const T &in)
124 std::stringstream tmp;
125 if (!(tmp << in)) return std::string();
129 /** Template function to convert any input type to any other type
130 * (usually an integer or numeric type)
132 template<typename T> inline long ConvToInt(const T &in)
134 std::stringstream tmp;
135 if (!(tmp << in)) return 0;
136 return atoi(tmp.str().c_str());
139 /** Template function to convert integer to char, storing result in *res and
140 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
141 * @param T input value
142 * @param V result value
143 * @param R base to convert to
145 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
147 if (base < 2 || base > 16) { *res = 0; return res; }
151 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
155 if ( in < 0 && base == 10) *out++ = '-';
156 std::reverse( res, out );
161 /** This class contains various STATS counters
162 * It is used by the InspIRCd class, which internally
163 * has an instance of it.
165 class serverstats : public classbase
168 /** Number of accepted connections
170 unsigned long statsAccept;
171 /** Number of failed accepts
173 unsigned long statsRefused;
174 /** Number of unknown commands seen
176 unsigned long statsUnknown;
177 /** Number of nickname collisions handled
179 unsigned long statsCollisions;
180 /** Number of DNS queries sent out
182 unsigned long statsDns;
183 /** Number of good DNS replies received
184 * NOTE: This may not tally to the number sent out,
185 * due to timeouts and other latency issues.
187 unsigned long statsDnsGood;
188 /** Number of bad (negative) DNS replies received
189 * NOTE: This may not tally to the number sent out,
190 * due to timeouts and other latency issues.
192 unsigned long statsDnsBad;
193 /** Number of inbound connections seen
195 unsigned long statsConnects;
196 /** Total bytes of data transmitted
199 /** Total bytes of data received
202 /** Cpu usage at last sample
205 /** Time last sample was read
208 /** The constructor initializes all the counts to zero
211 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
212 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
217 /** A list of failed port bindings, used for informational purposes on startup */
218 typedef std::vector<std::pair<std::string, long> > FailedPortList;
222 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
223 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
224 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
225 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
226 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
228 /* Forward declaration - required */
230 class BanCacheManager;
232 /** The main class of the irc server.
233 * This class contains instances of all the other classes
234 * in this software, with the exception of the base class,
235 * classbase. Amongst other things, it contains a ModeParser,
236 * a DNS object, a CommandParser object, and a list of active
237 * Module objects, and facilities for Module objects to
238 * interact with the core system it implements. You should
239 * NEVER attempt to instantiate a class of type InspIRCd
240 * yourself. If you do, this is equivalent to spawning a second
241 * IRC server, and could have catastrophic consequences for the
242 * program in terms of ram usage (basically, you could create
243 * an obese forkbomb built from recursively spawning irc servers!)
245 class CoreExport InspIRCd : public classbase
248 /** Holds the current UID. Used to generate the next one.
250 char current_uid[UUID_LENGTH];
252 /** Set up the signal handlers
256 /** Daemonize the ircd and close standard input/output streams
257 * @return True if the program daemonized succesfully
261 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
262 * @param TIME the current time
264 void DoSocketTimeouts(time_t TIME);
266 /** Sets up UID subsystem
268 void InitialiseUID();
270 /** Perform background user events such as PING checks
272 void DoBackgroundUserStuff();
274 /** Returns true when all modules have done pre-registration checks on a user
275 * @param user The user to verify
276 * @return True if all modules have finished checking this user
278 bool AllModulesReportReady(User* user);
280 /** Logfile pathname specified on the commandline, or empty string
282 char LogFileName[MAXBUF];
284 /** The current time, updated in the mainloop
288 /** The time that was recorded last time around the mainloop
292 /** A 64k buffer used to read client lines into
294 char ReadBuffer[65535];
296 /** Used when connecting clients
298 insp_sockaddr client, server;
300 /** Used when connecting clients
304 /** Nonblocking file writer
308 /** Time offset in seconds
309 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
319 /** Global cull list, will be processed on next iteration
321 CullList GlobalCulls;
325 ProcessUserHandler HandleProcessUser;
326 IsNickHandler HandleIsNick;
327 IsIdentHandler HandleIsIdent;
328 FindDescriptorHandler HandleFindDescriptor;
329 FloodQuitUserHandler HandleFloodQuitUser;
331 /** BufferedSocket classes pending deletion after being closed.
332 * We don't delete these immediately as this may cause a segmentation fault.
334 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
336 /** 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
339 * SendMode expects a User* to send the numeric replies
340 * back to, so we create it a fake user that isnt in the user
341 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
342 * falls into the abyss :p
346 /** Returns the next available UID for this server.
348 std::string GetUID();
350 /** Find a user in the UUID hash
351 * @param nick The nickname to find
352 * @return A pointer to the user, or NULL if the user does not exist
354 User *FindUUID(const std::string &);
356 /** Find a user in the UUID hash
357 * @param nick The nickname to find
358 * @return A pointer to the user, or NULL if the user does not exist
360 User *FindUUID(const char *);
362 /** Build the ISUPPORT string by triggering all modules On005Numeric events
364 void BuildISupport();
366 /** List of server names we've seen.
368 servernamelist servernames;
370 /** Time this ircd was booted
374 /** Config file pathname specified on the commandline or via ./configure
376 char ConfigFileName[MAXBUF];
378 /** Mode handler, handles mode setting and removal
382 /** Command parser, handles client to server commands
384 CommandParser* Parser;
386 /** Socket engine, handles socket activity events
390 /** ModuleManager contains everything related to loading/unloading
393 ModuleManager* Modules;
395 /** BanCacheManager is used to speed up checking of restrictions on connection
398 BanCacheManager *BanCache;
400 /** Stats class, holds miscellaneous stats counters
404 /** Server Config class, holds configuration file data
406 ServerConfig* Config;
408 /** Snomask manager - handles routing of snomask messages
413 /** DNS class, provides resolver facilities to the core and modules
417 /** Timer manager class, triggers Timer timer events
419 TimerManager* Timers;
421 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
423 XLineManager* XLines;
425 /** User manager. Various methods and data associated with users.
429 /** Channel list, a hash_map containing all channels XXX move to channel manager class
433 /** Set to the current signal recieved
437 /** Get the current time
438 * Because this only calls time() once every time around the mainloop,
439 * it is much faster than calling time() directly.
440 * @param delta True to use the delta as an offset, false otherwise
441 * @return The current time as an epoch value (time_t)
443 time_t Time(bool delta = false);
445 /** Set the time offset in seconds
446 * This offset is added to Time() to offset the system time by the specified
448 * @param delta The number of seconds to offset
449 * @return The old time delta
451 int SetTimeDelta(int delta);
453 /** Get the time offset in seconds
454 * @return The current time delta (in seconds)
458 /** Process a user whos socket has been flagged as active
459 * @param cu The user to process
460 * @return There is no actual return value, however upon exit, the user 'cu' may have been
461 * marked for deletion in the global CullList.
463 caller1<void, User*> ProcessUser;
465 /** Bind all ports specified in the configuration file.
466 * @param bail True if the function should bail back to the shell on failure
467 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
468 * @return The number of ports actually bound without error
470 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
472 /** Binds a socket on an already open file descriptor
473 * @param sockfd A valid file descriptor of an open socket
474 * @param port The port number to bind to
475 * @param addr The address to bind to (IP only)
476 * @return True if the port was bound successfully
478 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
480 /** Adds a server name to the list of servers we've seen
481 * @param The servername to add
483 void AddServerName(const std::string &servername);
485 /** Finds a cached char* pointer of a server name,
486 * This is used to optimize User by storing only the pointer to the name
487 * @param The servername to find
488 * @return A pointer to this name, gauranteed to never become invalid
490 const char* FindServerNamePtr(const std::string &servername);
492 /** Returns true if we've seen the given server name before
493 * @param The servername to find
494 * @return True if we've seen this server name before
496 bool FindServerName(const std::string &servername);
498 /** Gets the GECOS (description) field of the given server.
499 * If the servername is not that of the local server, the name
500 * is passed to handling modules which will attempt to determine
501 * the GECOS that bleongs to the given servername.
502 * @param servername The servername to find the description of
503 * @return The description of this server, or of the local server
505 std::string GetServerDescription(const char* servername);
507 /** Find a user in the nick hash.
508 * If the user cant be found in the nick hash check the uuid hash
509 * @param nick The nickname to find
510 * @return A pointer to the user, or NULL if the user does not exist
512 User* FindNick(const std::string &nick);
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 char* nick);
521 /** Find a user in the nick hash ONLY
523 User* FindNickOnly(const char* nick);
525 /** Find a user in the nick hash ONLY
527 User* FindNickOnly(const std::string &nick);
529 /** Find a channel in the channels hash
530 * @param chan The channel to find
531 * @return A pointer to the channel, or NULL if the channel does not exist
533 Channel* FindChan(const std::string &chan);
535 /** Find a channel in the channels hash
536 * @param chan The channel to find
537 * @return A pointer to the channel, or NULL if the channel does not exist
539 Channel* FindChan(const char* chan);
541 /** Check for a 'die' tag in the config file, and abort if found
542 * @return Depending on the configuration, this function may never return
546 /** Check we aren't running as root, and exit if we are
547 * @return Depending on the configuration, this function may never return
551 /** Determine the right path for, and open, the logfile
552 * @param argv The argv passed to main() initially, used to calculate program path
553 * @param argc The argc passed to main() initially, used to calculate program path
554 * @return True if the log could be opened, false if otherwise
556 bool OpenLog(char** argv, int argc);
558 /** Close the currently open log file
562 /** Return true if a channel name is valid
563 * @param chname A channel name to verify
564 * @return True if the name is valid
566 bool IsChannel(const char *chname);
568 /** Return true if str looks like a server ID
569 * @param string to check against
571 bool IsSID(const std::string &str);
573 /** Rehash the local server
577 /** Handles incoming signals after being set
578 * @param signal the signal recieved
580 void SignalHandler(int signal);
582 /** Sets the signal recieved
583 * @param signal the signal recieved
585 static void SetSignal(int signal);
587 /** Causes the server to exit after unloading modules and
588 * closing all open file descriptors.
590 * @param The exit code to give to the operating system
591 * (See the ExitStatus enum for valid values)
593 void Exit(int status);
595 /** Causes the server to exit immediately with exit code 0.
596 * The status code is required for signal handlers, and ignored.
598 static void QuickExit(int status);
600 /** Return a count of channels on the network
601 * @return The number of channels
605 /** Send an error notice to all local users, opered and unopered
606 * @param s The error string to send
608 void SendError(const std::string &s);
610 /** Return true if a nickname is valid
611 * @param n A nickname to verify
612 * @return True if the nick is valid
614 caller1<bool, const char*> IsNick;
616 /** Return true if an ident is valid
617 * @param An ident to verify
618 * @return True if the ident is valid
620 caller1<bool, const char*> IsIdent;
622 /** Find a username by their file descriptor.
623 * It is preferred to use this over directly accessing the fd_ref_table array.
624 * @param socket The file descriptor of a user
625 * @return A pointer to the user if the user exists locally on this descriptor
627 caller1<User*, int> FindDescriptor;
629 /** Add a dns Resolver class to this server's active set
630 * @param r The resolver to add
631 * @param cached If this value is true, then the cache will
632 * be searched for the DNS result, immediately. If the value is
633 * false, then a request will be sent to the nameserver, and the
634 * result will not be immediately available. You should usually
635 * use the boolean value which you passed to the Resolver
636 * constructor, which Resolver will set appropriately depending
637 * on if cached results are available and haven't expired. It is
638 * however safe to force this value to false, forcing a remote DNS
639 * lookup, but not an update of the cache.
640 * @return True if the operation completed successfully. Note that
641 * if this method returns true, you should not attempt to access
642 * the resolver class you pass it after this call, as depending upon
643 * the request given, the object may be deleted!
645 bool AddResolver(Resolver* r, bool cached);
647 /** Add a command to this server's command parser
648 * @param f A Command command handler object to add
649 * @throw ModuleException Will throw ModuleExcption if the command already exists
651 void AddCommand(Command *f);
653 /** Send a modechange.
654 * The parameters provided are identical to that sent to the
655 * handler for class cmd_mode.
656 * @param parameters The mode parameters
657 * @param pcnt The number of items you have given in the first parameter
658 * @param user The user to send error messages to
660 void SendMode(const char **parameters, int pcnt, User *user);
662 /** Match two strings using pattern matching.
663 * This operates identically to the global function match(),
664 * except for that it takes std::string arguments rather than
666 * @param sliteral The literal string to match against
667 * @param spattern The pattern to match against. CIDR and globs are supported.
669 bool MatchText(const std::string &sliteral, const std::string &spattern);
671 /** Call the handler for a given command.
672 * @param commandname The command whos handler you wish to call
673 * @param parameters The mode parameters
674 * @param pcnt The number of items you have given in the first parameter
675 * @param user The user to execute the command as
676 * @return True if the command handler was called successfully
678 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user);
680 /** Return true if the command is a module-implemented command and the given parameters are valid for it
681 * @param parameters The mode parameters
682 * @param pcnt The number of items you have given in the first parameter
683 * @param user The user to test-execute the command as
684 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
686 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
688 /** Return true if the given parameter is a valid nick!user\@host mask
689 * @param mask A nick!user\@host masak to match against
690 * @return True i the mask is valid
692 bool IsValidMask(const std::string &mask);
694 /** Rehash the local server
698 /** Return the channel whos index number matches that provided
699 * @param The index number of the channel to fetch
700 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
702 Channel* GetChannelIndex(long index);
704 /** Dump text to a user target, splitting it appropriately to fit
705 * @param User the user to dump the text to
706 * @param LinePrefix text to prefix each complete line with
707 * @param TextStream the text to send to the user
709 void DumpText(User* User, const std::string &LinePrefix, stringstream &TextStream);
711 /** Check if the given nickmask matches too many users, send errors to the given user
712 * @param nick A nickmask to match against
713 * @param user A user to send error text to
714 * @return True if the nick matches too many users
716 bool NickMatchesEveryone(const std::string &nick, User* user);
718 /** Check if the given IP mask matches too many users, send errors to the given user
719 * @param ip An ipmask to match against
720 * @param user A user to send error text to
721 * @return True if the ip matches too many users
723 bool IPMatchesEveryone(const std::string &ip, User* user);
725 /** Check if the given hostmask matches too many users, send errors to the given user
726 * @param mask A hostmask to match against
727 * @param user A user to send error text to
728 * @return True if the host matches too many users
730 bool HostMatchesEveryone(const std::string &mask, User* user);
732 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
733 * @param str A string containing a time in the form 1y2w3d4h6m5s
734 * (one year, two weeks, three days, four hours, six minutes and five seconds)
735 * @return The total number of seconds
737 long Duration(const std::string &str);
739 /** Attempt to compare a password to a string from the config file.
740 * This will be passed to handling modules which will compare the data
741 * against possible hashed equivalents in the input string.
742 * @param ex The object (user, server, whatever) causing the comparison.
743 * @param data The data from the config file
744 * @param input The data input by the oper
745 * @param hashtype The hash from the config file
746 * @return 0 if the strings match, 1 or -1 if they do not
748 int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
750 /** Check if a given server is a uline.
751 * An empty string returns true, this is by design.
752 * @param server The server to check for uline status
753 * @return True if the server is a uline OR the string is empty
755 bool ULine(const char* server);
757 /** Returns true if the uline is 'silent' (doesnt generate
758 * remote connect notices etc).
760 bool SilentULine(const char* server);
762 /** Returns the subversion revision ID of this ircd
763 * @return The revision ID or an empty string
765 std::string GetRevision();
767 /** Returns the full version string of this ircd
768 * @return The version string
770 std::string GetVersionString();
772 /** Attempt to write the process id to a given file
773 * @param filename The PID file to attempt to write to
774 * @return This function may bail if the file cannot be written
776 void WritePID(const std::string &filename);
778 /** This constructor initialises all the subsystems and reads the config file.
779 * @param argc The argument count passed to main()
780 * @param argv The argument list passed to main()
781 * @throw <anything> If anything is thrown from here and makes it to
782 * you, you should probably just give up and go home. Yes, really.
783 * It's that bad. Higher level classes should catch any non-fatal exceptions.
785 InspIRCd(int argc, char** argv);
787 /** Output a log message to the ircd.log file
788 * The text will only be output if the current loglevel
789 * is less than or equal to the level you provide
790 * @param level A log level from the DebugLevel enum
791 * @param text Format string of to write to the log
792 * @param ... Format arguments of text to write to the log
794 void Log(int level, const char* text, ...);
796 /** Output a log message to the ircd.log file
797 * The text will only be output if the current loglevel
798 * is less than or equal to the level you provide
799 * @param level A log level from the DebugLevel enum
800 * @param text Text to write to the log
802 void Log(int level, const std::string &text);
804 /** Send a line of WHOIS data to a user.
805 * @param user user to send the line to
806 * @param dest user being WHOISed
807 * @param numeric Numeric to send
808 * @param text Text of the numeric
810 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
812 /** Send a line of WHOIS data to a user.
813 * @param user user to send the line to
814 * @param dest user being WHOISed
815 * @param numeric Numeric to send
816 * @param format Format string for the numeric
817 * @param ... Parameters for the format string
819 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
821 /** Quit a user for excess flood, and if they are not
822 * fully registered yet, temporarily zline their IP.
823 * @param current user to quit
825 caller1<void, User*> FloodQuitUser;
827 /** Restart the server.
828 * This function will not return. If an error occurs,
829 * it will throw an instance of CoreException.
830 * @param reason The restart reason to show to all clients
831 * @throw CoreException An instance of CoreException indicating the error from execv().
833 void Restart(const std::string &reason);
835 /** Prepare the ircd for restart or shutdown.
836 * This function unloads all modules which can be unloaded,
837 * closes all open sockets, and closes the logfile.
841 /** This copies the user and channel hash_maps into new hash maps.
842 * This frees memory used by the hash_map allocator (which it neglects
843 * to free, most of the time, using tons of ram)
845 void RehashUsersAndChans();
847 /** Resets the cached max bans value on all channels.
852 /** Return a time_t as a human-readable string.
854 std::string TimeString(time_t curtime);
856 /** Begin execution of the server.
857 * NOTE: this function NEVER returns. Internally,
858 * it will repeatedly loop.
859 * @return The return value for this function is undefined.
863 /** Force all BufferedSockets to be removed which are due to
866 void BufferedSocketCull();
868 char* GetReadBuffer()
870 return this->ReadBuffer;