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.
40 #include "inspircd_config.h"
48 #include "usermanager.h"
51 #include "command_parse.h"
53 #include "socketengine.h"
55 #include "cull_list.h"
56 #include "filelogger.h"
59 #include "configreader.h"
60 #include "inspstring.h"
64 * Used to define the maximum number of parameters a command may have.
66 #define MAXPARAMETERS 127
68 /** Returned by some functions to indicate failure.
72 /** Support for librodent -
73 * see http://www.chatspike.net/index.php?z=64
75 #define ETIREDHAMSTERS EAGAIN
77 /** Template function to convert any input type to std::string
79 template<typename T> inline std::string ConvNumeric(const T &in)
81 if (in == 0) return "0";
86 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
93 std::reverse(res,out);
97 /** Template function to convert any input type to std::string
99 inline std::string ConvToStr(const int in)
101 return ConvNumeric(in);
104 /** Template function to convert any input type to std::string
106 inline std::string ConvToStr(const long in)
108 return ConvNumeric(in);
111 /** Template function to convert any input type to std::string
113 inline std::string ConvToStr(const char* in)
118 /** Template function to convert any input type to std::string
120 inline std::string ConvToStr(const bool in)
122 return (in ? "1" : "0");
125 /** Template function to convert any input type to std::string
127 inline std::string ConvToStr(char in)
129 return std::string(in,1);
132 /** Template function to convert any input type to std::string
134 template <class T> inline std::string ConvToStr(const T &in)
136 std::stringstream tmp;
137 if (!(tmp << in)) return std::string();
141 /** Template function to convert any input type to any other type
142 * (usually an integer or numeric type)
144 template<typename T> inline long ConvToInt(const T &in)
146 std::stringstream tmp;
147 if (!(tmp << in)) return 0;
148 return atoi(tmp.str().c_str());
151 template<typename CharT, typename TraitsT, std::size_t N>
152 static inline bool operator == (std::basic_string<CharT, TraitsT> const &lhs, char const (&rhs)[N])
154 return lhs.length() == N - 1 && !std::memcmp(lhs.data(), rhs, N - 1);
157 template<typename CharT, typename TraitsT, std::size_t N>
158 static inline bool operator != (std::basic_string<CharT, TraitsT> const &lhs, char const (&rhs)[N])
160 return !(lhs == rhs);
163 /** Template function to convert integer to char, storing result in *res and
164 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
165 * @param T input value
166 * @param V result value
167 * @param R base to convert to
169 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
171 if (base < 2 || base > 16) { *res = 0; return res; }
175 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
179 if ( in < 0 && base == 10) *out++ = '-';
180 std::reverse( res, out );
185 /** This class contains various STATS counters
186 * It is used by the InspIRCd class, which internally
187 * has an instance of it.
189 class serverstats : public classbase
192 /** Number of accepted connections
194 unsigned long statsAccept;
195 /** Number of failed accepts
197 unsigned long statsRefused;
198 /** Number of unknown commands seen
200 unsigned long statsUnknown;
201 /** Number of nickname collisions handled
203 unsigned long statsCollisions;
204 /** Number of DNS queries sent out
206 unsigned long statsDns;
207 /** Number of good 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 statsDnsGood;
212 /** Number of bad (negative) DNS replies received
213 * NOTE: This may not tally to the number sent out,
214 * due to timeouts and other latency issues.
216 unsigned long statsDnsBad;
217 /** Number of inbound connections seen
219 unsigned long statsConnects;
220 /** Total bytes of data transmitted
223 /** Total bytes of data received
226 /** Cpu usage at last sample
229 /** Time last sample was read
232 /** The constructor initializes all the counts to zero
235 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
236 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
241 /** A list of failed port bindings, used for informational purposes on startup */
242 typedef std::vector<std::pair<std::string, long> > FailedPortList;
246 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
247 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
248 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
249 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
250 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
251 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
252 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
253 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
255 /* Forward declaration - required */
257 class BanCacheManager;
259 class CoreExport ConfigReaderThread : public Thread
261 InspIRCd* ServerInstance;
265 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
269 virtual ~ConfigReaderThread()
276 /** The main class of the irc server.
277 * This class contains instances of all the other classes
278 * in this software, with the exception of the base class,
279 * classbase. Amongst other things, it contains a ModeParser,
280 * a DNS object, a CommandParser object, and a list of active
281 * Module objects, and facilities for Module objects to
282 * interact with the core system it implements. You should
283 * NEVER attempt to instantiate a class of type InspIRCd
284 * yourself. If you do, this is equivalent to spawning a second
285 * IRC server, and could have catastrophic consequences for the
286 * program in terms of ram usage (basically, you could create
287 * an obese forkbomb built from recursively spawning irc servers!)
289 class CoreExport InspIRCd : public classbase
292 /** Holds the current UID. Used to generate the next one.
294 char current_uid[UUID_LENGTH];
296 /** Set up the signal handlers
300 /** Daemonize the ircd and close standard input/output streams
301 * @return True if the program daemonized succesfully
305 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
306 * @param TIME the current time
308 void DoSocketTimeouts(time_t TIME);
310 /** Increments the current UID by one.
312 void IncrementUID(int pos);
314 /** Perform background user events such as PING checks
316 void DoBackgroundUserStuff();
318 /** Returns true when all modules have done pre-registration checks on a user
319 * @param user The user to verify
320 * @return True if all modules have finished checking this user
322 bool AllModulesReportReady(User* user);
324 /** Logfile pathname specified on the commandline, or empty string
326 char LogFileName[MAXBUF];
328 /** The current time, updated in the mainloop
332 /** The time that was recorded last time around the mainloop
336 /** A 64k buffer used to read client lines into
338 char ReadBuffer[65535];
340 /** Used when connecting clients
342 irc::sockets::insp_sockaddr client, server;
344 /** Used when connecting clients
354 /** Global cull list, will be processed on next iteration
356 CullList GlobalCulls;
360 ProcessUserHandler HandleProcessUser;
361 IsNickHandler HandleIsNick;
362 IsIdentHandler HandleIsIdent;
363 FindDescriptorHandler HandleFindDescriptor;
364 FloodQuitUserHandler HandleFloodQuitUser;
365 IsChannelHandler HandleIsChannel;
366 IsSIDHandler HandleIsSID;
367 RehashHandler HandleRehash;
369 /** BufferedSocket classes pending deletion after being closed.
370 * We don't delete these immediately as this may cause a segmentation fault.
372 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
374 /** 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
377 * SendMode expects a User* to send the numeric replies
378 * back to, so we create it a fake user that isnt in the user
379 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
380 * falls into the abyss :p
384 /** Returns the next available UID for this server.
386 std::string GetUID();
388 /** Find a user in the UUID hash
389 * @param nick The nickname to find
390 * @return A pointer to the user, or NULL if the user does not exist
392 User *FindUUID(const std::string &);
394 /** Find a user in the UUID hash
395 * @param nick The nickname to find
396 * @return A pointer to the user, or NULL if the user does not exist
398 User *FindUUID(const char *);
400 /** Build the ISUPPORT string by triggering all modules On005Numeric events
402 void BuildISupport();
404 /** List of server names we've seen.
406 servernamelist servernames;
408 /** Time this ircd was booted
412 /** Config file pathname specified on the commandline or via ./configure
414 char ConfigFileName[MAXBUF];
416 /** Mode handler, handles mode setting and removal
420 /** Command parser, handles client to server commands
422 CommandParser* Parser;
424 /** Socket engine, handles socket activity events
428 /** Thread engine, Handles threading where required
430 ThreadEngine* Threads;
432 /** The thread/class used to read config files in REHASH and on startup
434 ConfigReaderThread* ConfigThread;
436 /** LogManager handles logging.
440 /** ModuleManager contains everything related to loading/unloading
443 ModuleManager* Modules;
445 /** BanCacheManager is used to speed up checking of restrictions on connection
448 BanCacheManager *BanCache;
450 /** Stats class, holds miscellaneous stats counters
454 /** Server Config class, holds configuration file data
456 ServerConfig* Config;
458 /** Snomask manager - handles routing of snomask messages
463 /** DNS class, provides resolver facilities to the core and modules
467 /** Timer manager class, triggers Timer timer events
469 TimerManager* Timers;
471 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
473 XLineManager* XLines;
475 /** User manager. Various methods and data associated with users.
479 /** Channel list, a hash_map containing all channels XXX move to channel manager class
483 /** Set to the current signal recieved
487 /** Protocol interface, overridden by server protocol modules
489 ProtocolInterface* PI;
491 /** Get the current time
492 * Because this only calls time() once every time around the mainloop,
493 * it is much faster than calling time() directly.
494 * @return The current time as an epoch value (time_t)
498 /** Process a user whos socket has been flagged as active
499 * @param cu The user to process
500 * @return There is no actual return value, however upon exit, the user 'cu' may have been
501 * marked for deletion in the global CullList.
503 caller1<void, User*> ProcessUser;
505 /** Bind all ports specified in the configuration file.
506 * @param bail True if the function should bail back to the shell on failure
507 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
508 * @return The number of ports actually bound without error
510 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
512 /** Binds a socket on an already open file descriptor
513 * @param sockfd A valid file descriptor of an open socket
514 * @param port The port number to bind to
515 * @param addr The address to bind to (IP only)
516 * @return True if the port was bound successfully
518 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
520 /** Adds a server name to the list of servers we've seen
521 * @param The servername to add
523 void AddServerName(const std::string &servername);
525 /** Finds a cached char* pointer of a server name,
526 * This is used to optimize User by storing only the pointer to the name
527 * @param The servername to find
528 * @return A pointer to this name, gauranteed to never become invalid
530 const char* FindServerNamePtr(const std::string &servername);
532 /** Returns true if we've seen the given server name before
533 * @param The servername to find
534 * @return True if we've seen this server name before
536 bool FindServerName(const std::string &servername);
538 /** Gets the GECOS (description) field of the given server.
539 * If the servername is not that of the local server, the name
540 * is passed to handling modules which will attempt to determine
541 * the GECOS that bleongs to the given servername.
542 * @param servername The servername to find the description of
543 * @return The description of this server, or of the local server
545 std::string GetServerDescription(const char* servername);
547 /** Find a user in the nick hash.
548 * If the user cant be found in the nick hash check the uuid hash
549 * @param nick The nickname to find
550 * @return A pointer to the user, or NULL if the user does not exist
552 User* FindNick(const std::string &nick);
554 /** Find a user in the nick hash.
555 * If the user cant be found in the nick hash check the uuid hash
556 * @param nick The nickname to find
557 * @return A pointer to the user, or NULL if the user does not exist
559 User* FindNick(const char* nick);
561 /** Find a user in the nick hash ONLY
563 User* FindNickOnly(const char* nick);
565 /** Find a user in the nick hash ONLY
567 User* FindNickOnly(const std::string &nick);
569 /** Find a channel in the channels hash
570 * @param chan The channel to find
571 * @return A pointer to the channel, or NULL if the channel does not exist
573 Channel* FindChan(const std::string &chan);
575 /** Find a channel in the channels hash
576 * @param chan The channel to find
577 * @return A pointer to the channel, or NULL if the channel does not exist
579 Channel* FindChan(const char* chan);
581 /** Check for a 'die' tag in the config file, and abort if found
582 * @return Depending on the configuration, this function may never return
586 /** Check we aren't running as root, and exit if we are
587 * @return Depending on the configuration, this function may never return
591 /** Determine the right path for, and open, the logfile
592 * @param argv The argv passed to main() initially, used to calculate program path
593 * @param argc The argc passed to main() initially, used to calculate program path
594 * @return True if the log could be opened, false if otherwise
596 bool OpenLog(char** argv, int argc);
598 /** Return true if a channel name is valid
599 * @param chname A channel name to verify
600 * @return True if the name is valid
602 caller2<bool, const char*, size_t> IsChannel;
604 /** Return true if str looks like a server ID
605 * @param string to check against
607 caller1<bool, const std::string&> IsSID;
609 /** Rehash the local server
611 caller1<void, const std::string&> Rehash;
613 /** Handles incoming signals after being set
614 * @param signal the signal recieved
616 void SignalHandler(int signal);
618 /** Sets the signal recieved
619 * @param signal the signal recieved
621 static void SetSignal(int signal);
623 /** Causes the server to exit after unloading modules and
624 * closing all open file descriptors.
626 * @param The exit code to give to the operating system
627 * (See the ExitStatus enum for valid values)
629 void Exit(int status);
631 /** Causes the server to exit immediately with exit code 0.
632 * The status code is required for signal handlers, and ignored.
634 static void QuickExit(int status);
636 /** Return a count of channels on the network
637 * @return The number of channels
641 /** Send an error notice to all local users, opered and unopered
642 * @param s The error string to send
644 void SendError(const std::string &s);
646 /** Return true if a nickname is valid
647 * @param n A nickname to verify
648 * @return True if the nick is valid
650 caller2<bool, const char*, size_t> IsNick;
652 /** Return true if an ident is valid
653 * @param An ident to verify
654 * @return True if the ident is valid
656 caller1<bool, const char*> IsIdent;
658 /** Find a username by their file descriptor.
659 * It is preferred to use this over directly accessing the fd_ref_table array.
660 * @param socket The file descriptor of a user
661 * @return A pointer to the user if the user exists locally on this descriptor
663 caller1<User*, int> FindDescriptor;
665 /** Add a dns Resolver class to this server's active set
666 * @param r The resolver to add
667 * @param cached If this value is true, then the cache will
668 * be searched for the DNS result, immediately. If the value is
669 * false, then a request will be sent to the nameserver, and the
670 * result will not be immediately available. You should usually
671 * use the boolean value which you passed to the Resolver
672 * constructor, which Resolver will set appropriately depending
673 * on if cached results are available and haven't expired. It is
674 * however safe to force this value to false, forcing a remote DNS
675 * lookup, but not an update of the cache.
676 * @return True if the operation completed successfully. Note that
677 * if this method returns true, you should not attempt to access
678 * the resolver class you pass it after this call, as depending upon
679 * the request given, the object may be deleted!
681 bool AddResolver(Resolver* r, bool cached);
683 /** Add a command to this server's command parser
684 * @param f A Command command handler object to add
685 * @throw ModuleException Will throw ModuleExcption if the command already exists
687 void AddCommand(Command *f);
689 /** Send a modechange.
690 * The parameters provided are identical to that sent to the
691 * handler for class cmd_mode.
692 * @param parameters The mode parameters
693 * @param pcnt The number of items you have given in the first parameter
694 * @param user The user to send error messages to
696 void SendMode(const std::vector<std::string>& parameters, User *user);
698 /** Match two strings using pattern matching.
699 * This operates identically to the global function match(),
700 * except for that it takes std::string arguments rather than
702 * @param sliteral The literal string to match against
703 * @param spattern The pattern to match against. CIDR and globs are supported.
705 bool MatchText(const std::string &sliteral, const std::string &spattern);
707 /** Call the handler for a given command.
708 * @param commandname The command whos handler you wish to call
709 * @param parameters The mode parameters
710 * @param pcnt The number of items you have given in the first parameter
711 * @param user The user to execute the command as
712 * @return True if the command handler was called successfully
714 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
716 /** Return true if the command is a module-implemented command and the given parameters are valid for it
717 * @param parameters The mode parameters
718 * @param pcnt The number of items you have given in the first parameter
719 * @param user The user to test-execute the command as
720 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
722 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
724 /** Return true if the given parameter is a valid nick!user\@host mask
725 * @param mask A nick!user\@host masak to match against
726 * @return True i the mask is valid
728 bool IsValidMask(const std::string &mask);
730 /** Rehash the local server
734 /** Return the channel whos index number matches that provided
735 * @param The index number of the channel to fetch
736 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
738 Channel* GetChannelIndex(long index);
740 /** Dump text to a user target, splitting it appropriately to fit
741 * @param User the user to dump the text to
742 * @param LinePrefix text to prefix each complete line with
743 * @param TextStream the text to send to the user
745 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
747 /** Check if the given nickmask matches too many users, send errors to the given user
748 * @param nick A nickmask to match against
749 * @param user A user to send error text to
750 * @return True if the nick matches too many users
752 bool NickMatchesEveryone(const std::string &nick, User* user);
754 /** Check if the given IP mask matches too many users, send errors to the given user
755 * @param ip An ipmask to match against
756 * @param user A user to send error text to
757 * @return True if the ip matches too many users
759 bool IPMatchesEveryone(const std::string &ip, User* user);
761 /** Check if the given hostmask matches too many users, send errors to the given user
762 * @param mask A hostmask to match against
763 * @param user A user to send error text to
764 * @return True if the host matches too many users
766 bool HostMatchesEveryone(const std::string &mask, User* user);
768 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
769 * @param str A string containing a time in the form 1y2w3d4h6m5s
770 * (one year, two weeks, three days, four hours, six minutes and five seconds)
771 * @return The total number of seconds
773 long Duration(const std::string &str);
775 /** Attempt to compare a password to a string from the config file.
776 * This will be passed to handling modules which will compare the data
777 * against possible hashed equivalents in the input string.
778 * @param ex The object (user, server, whatever) causing the comparison.
779 * @param data The data from the config file
780 * @param input The data input by the oper
781 * @param hashtype The hash from the config file
782 * @return 0 if the strings match, 1 or -1 if they do not
784 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
786 /** Check if a given server is a uline.
787 * An empty string returns true, this is by design.
788 * @param server The server to check for uline status
789 * @return True if the server is a uline OR the string is empty
791 bool ULine(const char* server);
793 /** Returns true if the uline is 'silent' (doesnt generate
794 * remote connect notices etc).
796 bool SilentULine(const char* server);
798 /** Returns the subversion revision ID of this ircd
799 * @return The revision ID or an empty string
801 std::string GetRevision();
803 /** Returns the full version string of this ircd
804 * @return The version string
806 std::string GetVersionString();
808 /** Attempt to write the process id to a given file
809 * @param filename The PID file to attempt to write to
810 * @return This function may bail if the file cannot be written
812 void WritePID(const std::string &filename);
814 /** This constructor initialises all the subsystems and reads the config file.
815 * @param argc The argument count passed to main()
816 * @param argv The argument list passed to main()
817 * @throw <anything> If anything is thrown from here and makes it to
818 * you, you should probably just give up and go home. Yes, really.
819 * It's that bad. Higher level classes should catch any non-fatal exceptions.
821 InspIRCd(int argc, char** argv);
823 /** Send a line of WHOIS data to a user.
824 * @param user user to send the line to
825 * @param dest user being WHOISed
826 * @param numeric Numeric to send
827 * @param text Text of the numeric
829 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
831 /** Send a line of WHOIS data to a user.
832 * @param user user to send the line to
833 * @param dest user being WHOISed
834 * @param numeric Numeric to send
835 * @param format Format string for the numeric
836 * @param ... Parameters for the format string
838 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
840 /** Quit a user for excess flood, and if they are not
841 * fully registered yet, temporarily zline their IP.
842 * @param current user to quit
844 caller1<void, User*> FloodQuitUser;
846 /** Restart the server.
847 * This function will not return. If an error occurs,
848 * it will throw an instance of CoreException.
849 * @param reason The restart reason to show to all clients
850 * @throw CoreException An instance of CoreException indicating the error from execv().
852 void Restart(const std::string &reason);
854 /** Prepare the ircd for restart or shutdown.
855 * This function unloads all modules which can be unloaded,
856 * closes all open sockets, and closes the logfile.
860 /** This copies the user and channel hash_maps into new hash maps.
861 * This frees memory used by the hash_map allocator (which it neglects
862 * to free, most of the time, using tons of ram)
864 void RehashUsersAndChans();
866 /** Resets the cached max bans value on all channels.
871 /** Return a time_t as a human-readable string.
873 std::string TimeString(time_t curtime);
875 /** Begin execution of the server.
876 * NOTE: this function NEVER returns. Internally,
877 * it will repeatedly loop.
878 * @return The return value for this function is undefined.
882 /** Force all BufferedSockets to be removed which are due to
885 void BufferedSocketCull();
887 char* GetReadBuffer()
889 return this->ReadBuffer;