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 /** The main class of the irc server.
236 * This class contains instances of all the other classes
237 * in this software, with the exception of the base class,
238 * classbase. Amongst other things, it contains a ModeParser,
239 * a DNS object, a CommandParser object, and a list of active
240 * Module objects, and facilities for Module objects to
241 * interact with the core system it implements. You should
242 * NEVER attempt to instantiate a class of type InspIRCd
243 * yourself. If you do, this is equivalent to spawning a second
244 * IRC server, and could have catastrophic consequences for the
245 * program in terms of ram usage (basically, you could create
246 * an obese forkbomb built from recursively spawning irc servers!)
248 class CoreExport InspIRCd : public classbase
251 /** Holds the current UID. Used to generate the next one.
253 char current_uid[UUID_LENGTH];
255 /** Set up the signal handlers
259 /** Daemonize the ircd and close standard input/output streams
260 * @return True if the program daemonized succesfully
264 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
265 * @param TIME the current time
267 void DoSocketTimeouts(time_t TIME);
269 /** Sets up UID subsystem
271 void InitialiseUID();
273 /** Perform background user events such as PING checks
275 void DoBackgroundUserStuff();
277 /** Returns true when all modules have done pre-registration checks on a user
278 * @param user The user to verify
279 * @return True if all modules have finished checking this user
281 bool AllModulesReportReady(User* user);
283 /** Logfile pathname specified on the commandline, or empty string
285 char LogFileName[MAXBUF];
287 /** The current time, updated in the mainloop
291 /** The time that was recorded last time around the mainloop
295 /** A 64k buffer used to read client lines into
297 char ReadBuffer[65535];
299 /** Used when connecting clients
301 irc::sockets::insp_sockaddr client, server;
303 /** Used when connecting clients
313 /** Global cull list, will be processed on next iteration
315 CullList GlobalCulls;
319 ProcessUserHandler HandleProcessUser;
320 IsNickHandler HandleIsNick;
321 IsIdentHandler HandleIsIdent;
322 FindDescriptorHandler HandleFindDescriptor;
323 FloodQuitUserHandler HandleFloodQuitUser;
325 /** BufferedSocket classes pending deletion after being closed.
326 * We don't delete these immediately as this may cause a segmentation fault.
328 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
330 /** 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
333 * SendMode expects a User* to send the numeric replies
334 * back to, so we create it a fake user that isnt in the user
335 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
336 * falls into the abyss :p
340 /** Returns the next available UID for this server.
342 std::string GetUID();
344 /** Find a user in the UUID hash
345 * @param nick The nickname to find
346 * @return A pointer to the user, or NULL if the user does not exist
348 User *FindUUID(const std::string &);
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 char *);
356 /** Build the ISUPPORT string by triggering all modules On005Numeric events
358 void BuildISupport();
360 /** List of server names we've seen.
362 servernamelist servernames;
364 /** Time this ircd was booted
368 /** Config file pathname specified on the commandline or via ./configure
370 char ConfigFileName[MAXBUF];
372 /** Mode handler, handles mode setting and removal
376 /** Command parser, handles client to server commands
378 CommandParser* Parser;
380 /** Socket engine, handles socket activity events
384 /** LogManager handles logging.
388 /** ModuleManager contains everything related to loading/unloading
391 ModuleManager* Modules;
393 /** BanCacheManager is used to speed up checking of restrictions on connection
396 BanCacheManager *BanCache;
398 /** Stats class, holds miscellaneous stats counters
402 /** Server Config class, holds configuration file data
404 ServerConfig* Config;
406 /** Snomask manager - handles routing of snomask messages
411 /** DNS class, provides resolver facilities to the core and modules
415 /** Timer manager class, triggers Timer timer events
417 TimerManager* Timers;
419 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
421 XLineManager* XLines;
423 /** User manager. Various methods and data associated with users.
427 /** Channel list, a hash_map containing all channels XXX move to channel manager class
431 /** Set to the current signal recieved
435 /** Get the current time
436 * Because this only calls time() once every time around the mainloop,
437 * it is much faster than calling time() directly.
438 * @return The current time as an epoch value (time_t)
442 /** Process a user whos socket has been flagged as active
443 * @param cu The user to process
444 * @return There is no actual return value, however upon exit, the user 'cu' may have been
445 * marked for deletion in the global CullList.
447 caller1<void, User*> ProcessUser;
449 /** Bind all ports specified in the configuration file.
450 * @param bail True if the function should bail back to the shell on failure
451 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
452 * @return The number of ports actually bound without error
454 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
456 /** Binds a socket on an already open file descriptor
457 * @param sockfd A valid file descriptor of an open socket
458 * @param port The port number to bind to
459 * @param addr The address to bind to (IP only)
460 * @return True if the port was bound successfully
462 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
464 /** Adds a server name to the list of servers we've seen
465 * @param The servername to add
467 void AddServerName(const std::string &servername);
469 /** Finds a cached char* pointer of a server name,
470 * This is used to optimize User by storing only the pointer to the name
471 * @param The servername to find
472 * @return A pointer to this name, gauranteed to never become invalid
474 const char* FindServerNamePtr(const std::string &servername);
476 /** Returns true if we've seen the given server name before
477 * @param The servername to find
478 * @return True if we've seen this server name before
480 bool FindServerName(const std::string &servername);
482 /** Gets the GECOS (description) field of the given server.
483 * If the servername is not that of the local server, the name
484 * is passed to handling modules which will attempt to determine
485 * the GECOS that bleongs to the given servername.
486 * @param servername The servername to find the description of
487 * @return The description of this server, or of the local server
489 std::string GetServerDescription(const char* servername);
491 /** Find a user in the nick hash.
492 * If the user cant be found in the nick hash check the uuid hash
493 * @param nick The nickname to find
494 * @return A pointer to the user, or NULL if the user does not exist
496 User* FindNick(const std::string &nick);
498 /** Find a user in the nick hash.
499 * If the user cant be found in the nick hash check the uuid hash
500 * @param nick The nickname to find
501 * @return A pointer to the user, or NULL if the user does not exist
503 User* FindNick(const char* nick);
505 /** Find a user in the nick hash ONLY
507 User* FindNickOnly(const char* nick);
509 /** Find a user in the nick hash ONLY
511 User* FindNickOnly(const std::string &nick);
513 /** Find a channel in the channels hash
514 * @param chan The channel to find
515 * @return A pointer to the channel, or NULL if the channel does not exist
517 Channel* FindChan(const std::string &chan);
519 /** Find a channel in the channels hash
520 * @param chan The channel to find
521 * @return A pointer to the channel, or NULL if the channel does not exist
523 Channel* FindChan(const char* chan);
525 /** Check for a 'die' tag in the config file, and abort if found
526 * @return Depending on the configuration, this function may never return
530 /** Check we aren't running as root, and exit if we are
531 * @return Depending on the configuration, this function may never return
535 /** Determine the right path for, and open, the logfile
536 * @param argv The argv passed to main() initially, used to calculate program path
537 * @param argc The argc passed to main() initially, used to calculate program path
538 * @return True if the log could be opened, false if otherwise
540 bool OpenLog(char** argv, int argc);
542 /** Return true if a channel name is valid
543 * @param chname A channel name to verify
544 * @return True if the name is valid
546 bool IsChannel(const char *chname);
548 /** Return true if str looks like a server ID
549 * @param string to check against
551 bool IsSID(const std::string &str);
553 /** Rehash the local server
557 /** Handles incoming signals after being set
558 * @param signal the signal recieved
560 void SignalHandler(int signal);
562 /** Sets the signal recieved
563 * @param signal the signal recieved
565 static void SetSignal(int signal);
567 /** Causes the server to exit after unloading modules and
568 * closing all open file descriptors.
570 * @param The exit code to give to the operating system
571 * (See the ExitStatus enum for valid values)
573 void Exit(int status);
575 /** Causes the server to exit immediately with exit code 0.
576 * The status code is required for signal handlers, and ignored.
578 static void QuickExit(int status);
580 /** Return a count of channels on the network
581 * @return The number of channels
585 /** Send an error notice to all local users, opered and unopered
586 * @param s The error string to send
588 void SendError(const std::string &s);
590 /** Return true if a nickname is valid
591 * @param n A nickname to verify
592 * @return True if the nick is valid
594 caller1<bool, const char*> IsNick;
596 /** Return true if an ident is valid
597 * @param An ident to verify
598 * @return True if the ident is valid
600 caller1<bool, const char*> IsIdent;
602 /** Find a username by their file descriptor.
603 * It is preferred to use this over directly accessing the fd_ref_table array.
604 * @param socket The file descriptor of a user
605 * @return A pointer to the user if the user exists locally on this descriptor
607 caller1<User*, int> FindDescriptor;
609 /** Add a dns Resolver class to this server's active set
610 * @param r The resolver to add
611 * @param cached If this value is true, then the cache will
612 * be searched for the DNS result, immediately. If the value is
613 * false, then a request will be sent to the nameserver, and the
614 * result will not be immediately available. You should usually
615 * use the boolean value which you passed to the Resolver
616 * constructor, which Resolver will set appropriately depending
617 * on if cached results are available and haven't expired. It is
618 * however safe to force this value to false, forcing a remote DNS
619 * lookup, but not an update of the cache.
620 * @return True if the operation completed successfully. Note that
621 * if this method returns true, you should not attempt to access
622 * the resolver class you pass it after this call, as depending upon
623 * the request given, the object may be deleted!
625 bool AddResolver(Resolver* r, bool cached);
627 /** Add a command to this server's command parser
628 * @param f A Command command handler object to add
629 * @throw ModuleException Will throw ModuleExcption if the command already exists
631 void AddCommand(Command *f);
633 /** Send a modechange.
634 * The parameters provided are identical to that sent to the
635 * handler for class cmd_mode.
636 * @param parameters The mode parameters
637 * @param pcnt The number of items you have given in the first parameter
638 * @param user The user to send error messages to
640 void SendMode(const char* const* parameters, int pcnt, User *user);
642 /** Match two strings using pattern matching.
643 * This operates identically to the global function match(),
644 * except for that it takes std::string arguments rather than
646 * @param sliteral The literal string to match against
647 * @param spattern The pattern to match against. CIDR and globs are supported.
649 bool MatchText(const std::string &sliteral, const std::string &spattern);
651 /** Call the handler for a given command.
652 * @param commandname The command whos handler you wish to call
653 * @param parameters The mode parameters
654 * @param pcnt The number of items you have given in the first parameter
655 * @param user The user to execute the command as
656 * @return True if the command handler was called successfully
658 CmdResult CallCommandHandler(const std::string &commandname, const char* const* parameters, int pcnt, User* user);
660 /** Return true if the command is a module-implemented command and the given parameters are valid for it
661 * @param parameters The mode parameters
662 * @param pcnt The number of items you have given in the first parameter
663 * @param user The user to test-execute the command as
664 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
666 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
668 /** Return true if the given parameter is a valid nick!user\@host mask
669 * @param mask A nick!user\@host masak to match against
670 * @return True i the mask is valid
672 bool IsValidMask(const std::string &mask);
674 /** Rehash the local server
678 /** Return the channel whos index number matches that provided
679 * @param The index number of the channel to fetch
680 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
682 Channel* GetChannelIndex(long index);
684 /** Dump text to a user target, splitting it appropriately to fit
685 * @param User the user to dump the text to
686 * @param LinePrefix text to prefix each complete line with
687 * @param TextStream the text to send to the user
689 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
691 /** Check if the given nickmask matches too many users, send errors to the given user
692 * @param nick A nickmask to match against
693 * @param user A user to send error text to
694 * @return True if the nick matches too many users
696 bool NickMatchesEveryone(const std::string &nick, User* user);
698 /** Check if the given IP mask matches too many users, send errors to the given user
699 * @param ip An ipmask to match against
700 * @param user A user to send error text to
701 * @return True if the ip matches too many users
703 bool IPMatchesEveryone(const std::string &ip, User* user);
705 /** Check if the given hostmask matches too many users, send errors to the given user
706 * @param mask A hostmask to match against
707 * @param user A user to send error text to
708 * @return True if the host matches too many users
710 bool HostMatchesEveryone(const std::string &mask, User* user);
712 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
713 * @param str A string containing a time in the form 1y2w3d4h6m5s
714 * (one year, two weeks, three days, four hours, six minutes and five seconds)
715 * @return The total number of seconds
717 long Duration(const std::string &str);
719 /** Attempt to compare a password to a string from the config file.
720 * This will be passed to handling modules which will compare the data
721 * against possible hashed equivalents in the input string.
722 * @param ex The object (user, server, whatever) causing the comparison.
723 * @param data The data from the config file
724 * @param input The data input by the oper
725 * @param hashtype The hash from the config file
726 * @return 0 if the strings match, 1 or -1 if they do not
728 int PassCompare(Extensible* ex, const char* data,const char* input, const char* hashtype);
730 /** Check if a given server is a uline.
731 * An empty string returns true, this is by design.
732 * @param server The server to check for uline status
733 * @return True if the server is a uline OR the string is empty
735 bool ULine(const char* server);
737 /** Returns true if the uline is 'silent' (doesnt generate
738 * remote connect notices etc).
740 bool SilentULine(const char* server);
742 /** Returns the subversion revision ID of this ircd
743 * @return The revision ID or an empty string
745 std::string GetRevision();
747 /** Returns the full version string of this ircd
748 * @return The version string
750 std::string GetVersionString();
752 /** Attempt to write the process id to a given file
753 * @param filename The PID file to attempt to write to
754 * @return This function may bail if the file cannot be written
756 void WritePID(const std::string &filename);
758 /** This constructor initialises all the subsystems and reads the config file.
759 * @param argc The argument count passed to main()
760 * @param argv The argument list passed to main()
761 * @throw <anything> If anything is thrown from here and makes it to
762 * you, you should probably just give up and go home. Yes, really.
763 * It's that bad. Higher level classes should catch any non-fatal exceptions.
765 InspIRCd(int argc, char** argv);
767 /** Output a log message to the ircd.log file
768 * The text will only be output if the current loglevel
769 * is less than or equal to the level you provide
770 * @param level A log level from the DebugLevel enum
771 * @param text Format string of to write to the log
772 * @param ... Format arguments of text to write to the log
774 void Log(int level, const char* text, ...);
776 /** Output a log message to the ircd.log file
777 * The text will only be output if the current loglevel
778 * is less than or equal to the level you provide
779 * @param level A log level from the DebugLevel enum
780 * @param text Text to write to the log
782 void Log(int level, const std::string &text);
784 /** Send a line of WHOIS data to a user.
785 * @param user user to send the line to
786 * @param dest user being WHOISed
787 * @param numeric Numeric to send
788 * @param text Text of the numeric
790 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
792 /** Send a line of WHOIS data to a user.
793 * @param user user to send the line to
794 * @param dest user being WHOISed
795 * @param numeric Numeric to send
796 * @param format Format string for the numeric
797 * @param ... Parameters for the format string
799 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
801 /** Quit a user for excess flood, and if they are not
802 * fully registered yet, temporarily zline their IP.
803 * @param current user to quit
805 caller1<void, User*> FloodQuitUser;
807 /** Restart the server.
808 * This function will not return. If an error occurs,
809 * it will throw an instance of CoreException.
810 * @param reason The restart reason to show to all clients
811 * @throw CoreException An instance of CoreException indicating the error from execv().
813 void Restart(const std::string &reason);
815 /** Prepare the ircd for restart or shutdown.
816 * This function unloads all modules which can be unloaded,
817 * closes all open sockets, and closes the logfile.
821 /** This copies the user and channel hash_maps into new hash maps.
822 * This frees memory used by the hash_map allocator (which it neglects
823 * to free, most of the time, using tons of ram)
825 void RehashUsersAndChans();
827 /** Resets the cached max bans value on all channels.
832 /** Return a time_t as a human-readable string.
834 std::string TimeString(time_t curtime);
836 /** Begin execution of the server.
837 * NOTE: this function NEVER returns. Internally,
838 * it will repeatedly loop.
839 * @return The return value for this function is undefined.
843 /** Force all BufferedSockets to be removed which are due to
846 void BufferedSocketCull();
848 char* GetReadBuffer()
850 return this->ReadBuffer;