1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __INSPIRCD_H__
15 #define __INSPIRCD_H__
20 #define printf_c printf
22 #include "inspircd_win32wrapper.h"
23 /** Windows defines these already */
29 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
31 #define CUSTOM_PRINTF(STRING, FIRST)
34 // Required system headers.
42 #include "inspircd_config.h"
50 #include "usermanager.h"
53 #include "command_parse.h"
55 #include "socketengine.h"
57 #include "cull_list.h"
58 #include "filelogger.h"
61 #include "configreader.h"
62 #include "inspstring.h"
64 #include <limits.h> // required for PATH_MAX under gcc 4.3, may break windows
66 #warning Potentially broken system, PATH_MAX undefined
71 * Used to define the maximum number of parameters a command may have.
73 #define MAXPARAMETERS 127
75 /** Returned by some functions to indicate failure.
79 /** Support for librodent -
80 * see http://www.chatspike.net/index.php?z=64
82 #define ETIREDHAMSTERS EAGAIN
84 /** Template function to convert any input type to std::string
86 template<typename T> inline std::string ConvNumeric(const T &in)
88 if (in == 0) return "0";
93 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
100 std::reverse(res,out);
104 /** Template function to convert any input type to std::string
106 inline std::string ConvToStr(const int in)
108 return ConvNumeric(in);
111 /** Template function to convert any input type to std::string
113 inline std::string ConvToStr(const long in)
115 return ConvNumeric(in);
118 /** Template function to convert any input type to std::string
120 inline std::string ConvToStr(const char* in)
125 /** Template function to convert any input type to std::string
127 inline std::string ConvToStr(const bool in)
129 return (in ? "1" : "0");
132 /** Template function to convert any input type to std::string
134 inline std::string ConvToStr(char in)
136 return std::string(in,1);
139 /** Template function to convert any input type to std::string
141 template <class T> inline std::string ConvToStr(const T &in)
143 std::stringstream tmp;
144 if (!(tmp << in)) return std::string();
148 /** Template function to convert any input type to any other type
149 * (usually an integer or numeric type)
151 template<typename T> inline long ConvToInt(const T &in)
153 std::stringstream tmp;
154 if (!(tmp << in)) return 0;
155 return atoi(tmp.str().c_str());
158 /** Template function to convert integer to char, storing result in *res and
159 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
160 * @param T input value
161 * @param V result value
162 * @param R base to convert to
164 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
166 if (base < 2 || base > 16) { *res = 0; return res; }
170 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
174 if ( in < 0 && base == 10) *out++ = '-';
175 std::reverse( res, out );
180 /** This class contains various STATS counters
181 * It is used by the InspIRCd class, which internally
182 * has an instance of it.
184 class serverstats : public classbase
187 /** Number of accepted connections
189 unsigned long statsAccept;
190 /** Number of failed accepts
192 unsigned long statsRefused;
193 /** Number of unknown commands seen
195 unsigned long statsUnknown;
196 /** Number of nickname collisions handled
198 unsigned long statsCollisions;
199 /** Number of DNS queries sent out
201 unsigned long statsDns;
202 /** Number of good DNS replies received
203 * NOTE: This may not tally to the number sent out,
204 * due to timeouts and other latency issues.
206 unsigned long statsDnsGood;
207 /** Number of bad (negative) DNS replies received
208 * NOTE: This may not tally to the number sent out,
209 * due to timeouts and other latency issues.
211 unsigned long statsDnsBad;
212 /** Number of inbound connections seen
214 unsigned long statsConnects;
215 /** Total bytes of data transmitted
218 /** Total bytes of data received
221 /** Cpu usage at last sample
224 /** Time last sample was read
227 /** The constructor initializes all the counts to zero
230 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
231 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
236 /** A list of failed port bindings, used for informational purposes on startup */
237 typedef std::vector<std::pair<std::string, long> > FailedPortList;
241 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
242 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
243 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
244 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
245 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
246 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
247 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
248 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
250 /* Forward declaration - required */
252 class BanCacheManager;
254 class CoreExport ConfigReaderThread : public Thread
256 InspIRCd* ServerInstance;
260 ConfigReaderThread(InspIRCd* Instance, bool bail, User* user) : Thread(), ServerInstance(Instance), do_bail(bail), TheUser(user)
264 virtual ~ConfigReaderThread()
271 /** The main class of the irc server.
272 * This class contains instances of all the other classes
273 * in this software, with the exception of the base class,
274 * classbase. Amongst other things, it contains a ModeParser,
275 * a DNS object, a CommandParser object, and a list of active
276 * Module objects, and facilities for Module objects to
277 * interact with the core system it implements. You should
278 * NEVER attempt to instantiate a class of type InspIRCd
279 * yourself. If you do, this is equivalent to spawning a second
280 * IRC server, and could have catastrophic consequences for the
281 * program in terms of ram usage (basically, you could create
282 * an obese forkbomb built from recursively spawning irc servers!)
284 class CoreExport InspIRCd : public classbase
287 /** Holds the current UID. Used to generate the next one.
289 char current_uid[UUID_LENGTH];
291 /** Set up the signal handlers
295 /** Daemonize the ircd and close standard input/output streams
296 * @return True if the program daemonized succesfully
300 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
301 * @param TIME the current time
303 void DoSocketTimeouts(time_t TIME);
305 /** Increments the current UID by one.
307 void IncrementUID(int pos);
309 /** Perform background user events such as PING checks
311 void DoBackgroundUserStuff();
313 /** Returns true when all modules have done pre-registration checks on a user
314 * @param user The user to verify
315 * @return True if all modules have finished checking this user
317 bool AllModulesReportReady(User* user);
319 /** Logfile pathname specified on the commandline, or empty string
321 char LogFileName[MAXBUF];
323 /** The current time, updated in the mainloop
327 /** The time that was recorded last time around the mainloop
331 /** A 64k buffer used to read client lines into
333 char ReadBuffer[65535];
335 /** Used when connecting clients
337 irc::sockets::insp_sockaddr client, server;
339 /** Used when connecting clients
349 /** Global cull list, will be processed on next iteration
351 CullList GlobalCulls;
355 ProcessUserHandler HandleProcessUser;
356 IsNickHandler HandleIsNick;
357 IsIdentHandler HandleIsIdent;
358 FindDescriptorHandler HandleFindDescriptor;
359 FloodQuitUserHandler HandleFloodQuitUser;
360 IsChannelHandler HandleIsChannel;
361 IsSIDHandler HandleIsSID;
362 RehashHandler HandleRehash;
364 /** BufferedSocket classes pending deletion after being closed.
365 * We don't delete these immediately as this may cause a segmentation fault.
367 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
369 /** 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
372 * SendMode expects a User* to send the numeric replies
373 * back to, so we create it a fake user that isnt in the user
374 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
375 * falls into the abyss :p
379 /** Returns the next available UID for this server.
381 std::string GetUID();
383 /** Find a user in the UUID hash
384 * @param nick The nickname to find
385 * @return A pointer to the user, or NULL if the user does not exist
387 User *FindUUID(const std::string &);
389 /** Find a user in the UUID hash
390 * @param nick The nickname to find
391 * @return A pointer to the user, or NULL if the user does not exist
393 User *FindUUID(const char *);
395 /** Build the ISUPPORT string by triggering all modules On005Numeric events
397 void BuildISupport();
399 /** List of server names we've seen.
401 servernamelist servernames;
403 /** Time this ircd was booted
407 /** Config file pathname specified on the commandline or via ./configure
409 char ConfigFileName[MAXBUF];
411 /** Mode handler, handles mode setting and removal
415 /** Command parser, handles client to server commands
417 CommandParser* Parser;
419 /** Socket engine, handles socket activity events
423 /** Thread engine, Handles threading where required
425 ThreadEngine* Threads;
427 /** The thread/class used to read config files in REHASH and on startup
429 ConfigReaderThread* ConfigThread;
431 /** LogManager handles logging.
435 /** ModuleManager contains everything related to loading/unloading
438 ModuleManager* Modules;
440 /** BanCacheManager is used to speed up checking of restrictions on connection
443 BanCacheManager *BanCache;
445 /** Stats class, holds miscellaneous stats counters
449 /** Server Config class, holds configuration file data
451 ServerConfig* Config;
453 /** Snomask manager - handles routing of snomask messages
458 /** DNS class, provides resolver facilities to the core and modules
462 /** Timer manager class, triggers Timer timer events
464 TimerManager* Timers;
466 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
468 XLineManager* XLines;
470 /** User manager. Various methods and data associated with users.
474 /** Channel list, a hash_map containing all channels XXX move to channel manager class
478 /** Set to the current signal recieved
482 /** Protocol interface, overridden by server protocol modules
484 ProtocolInterface* PI;
486 /** Get the current time
487 * Because this only calls time() once every time around the mainloop,
488 * it is much faster than calling time() directly.
489 * @return The current time as an epoch value (time_t)
493 /** Process a user whos socket has been flagged as active
494 * @param cu The user to process
495 * @return There is no actual return value, however upon exit, the user 'cu' may have been
496 * marked for deletion in the global CullList.
498 caller1<void, User*> ProcessUser;
500 /** Bind all ports specified in the configuration file.
501 * @param bail True if the function should bail back to the shell on failure
502 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
503 * @return The number of ports actually bound without error
505 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
507 /** Binds a socket on an already open file descriptor
508 * @param sockfd A valid file descriptor of an open socket
509 * @param port The port number to bind to
510 * @param addr The address to bind to (IP only)
511 * @return True if the port was bound successfully
513 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
515 /** Adds a server name to the list of servers we've seen
516 * @param The servername to add
518 void AddServerName(const std::string &servername);
520 /** Finds a cached char* pointer of a server name,
521 * This is used to optimize User by storing only the pointer to the name
522 * @param The servername to find
523 * @return A pointer to this name, gauranteed to never become invalid
525 const char* FindServerNamePtr(const std::string &servername);
527 /** Returns true if we've seen the given server name before
528 * @param The servername to find
529 * @return True if we've seen this server name before
531 bool FindServerName(const std::string &servername);
533 /** Gets the GECOS (description) field of the given server.
534 * If the servername is not that of the local server, the name
535 * is passed to handling modules which will attempt to determine
536 * the GECOS that bleongs to the given servername.
537 * @param servername The servername to find the description of
538 * @return The description of this server, or of the local server
540 std::string GetServerDescription(const char* servername);
542 /** Find a user in the nick hash.
543 * If the user cant be found in the nick hash check the uuid hash
544 * @param nick The nickname to find
545 * @return A pointer to the user, or NULL if the user does not exist
547 User* FindNick(const std::string &nick);
549 /** Find a user in the nick hash.
550 * If the user cant be found in the nick hash check the uuid hash
551 * @param nick The nickname to find
552 * @return A pointer to the user, or NULL if the user does not exist
554 User* FindNick(const char* nick);
556 /** Find a user in the nick hash ONLY
558 User* FindNickOnly(const char* nick);
560 /** Find a user in the nick hash ONLY
562 User* FindNickOnly(const std::string &nick);
564 /** Find a channel in the channels hash
565 * @param chan The channel to find
566 * @return A pointer to the channel, or NULL if the channel does not exist
568 Channel* FindChan(const std::string &chan);
570 /** Find a channel in the channels hash
571 * @param chan The channel to find
572 * @return A pointer to the channel, or NULL if the channel does not exist
574 Channel* FindChan(const char* chan);
576 /** Check for a 'die' tag in the config file, and abort if found
577 * @return Depending on the configuration, this function may never return
581 /** Check we aren't running as root, and exit if we are
582 * @return Depending on the configuration, this function may never return
586 /** Determine the right path for, and open, the logfile
587 * @param argv The argv passed to main() initially, used to calculate program path
588 * @param argc The argc passed to main() initially, used to calculate program path
589 * @return True if the log could be opened, false if otherwise
591 bool OpenLog(char** argv, int argc);
593 /** Return true if a channel name is valid
594 * @param chname A channel name to verify
595 * @return True if the name is valid
597 caller2<bool, const char*, size_t> IsChannel;
599 /** Return true if str looks like a server ID
600 * @param string to check against
602 caller1<bool, const std::string&> IsSID;
604 /** Rehash the local server
606 caller1<void, const std::string&> Rehash;
608 /** Handles incoming signals after being set
609 * @param signal the signal recieved
611 void SignalHandler(int signal);
613 /** Sets the signal recieved
614 * @param signal the signal recieved
616 static void SetSignal(int signal);
618 /** Causes the server to exit after unloading modules and
619 * closing all open file descriptors.
621 * @param The exit code to give to the operating system
622 * (See the ExitStatus enum for valid values)
624 void Exit(int status);
626 /** Causes the server to exit immediately with exit code 0.
627 * The status code is required for signal handlers, and ignored.
629 static void QuickExit(int status);
631 /** Return a count of channels on the network
632 * @return The number of channels
636 /** Send an error notice to all local users, opered and unopered
637 * @param s The error string to send
639 void SendError(const std::string &s);
641 /** Return true if a nickname is valid
642 * @param n A nickname to verify
643 * @return True if the nick is valid
645 caller2<bool, const char*, size_t> IsNick;
647 /** Return true if an ident is valid
648 * @param An ident to verify
649 * @return True if the ident is valid
651 caller1<bool, const char*> IsIdent;
653 /** Find a username by their file descriptor.
654 * It is preferred to use this over directly accessing the fd_ref_table array.
655 * @param socket The file descriptor of a user
656 * @return A pointer to the user if the user exists locally on this descriptor
658 caller1<User*, int> FindDescriptor;
660 /** Add a dns Resolver class to this server's active set
661 * @param r The resolver to add
662 * @param cached If this value is true, then the cache will
663 * be searched for the DNS result, immediately. If the value is
664 * false, then a request will be sent to the nameserver, and the
665 * result will not be immediately available. You should usually
666 * use the boolean value which you passed to the Resolver
667 * constructor, which Resolver will set appropriately depending
668 * on if cached results are available and haven't expired. It is
669 * however safe to force this value to false, forcing a remote DNS
670 * lookup, but not an update of the cache.
671 * @return True if the operation completed successfully. Note that
672 * if this method returns true, you should not attempt to access
673 * the resolver class you pass it after this call, as depending upon
674 * the request given, the object may be deleted!
676 bool AddResolver(Resolver* r, bool cached);
678 /** Add a command to this server's command parser
679 * @param f A Command command handler object to add
680 * @throw ModuleException Will throw ModuleExcption if the command already exists
682 void AddCommand(Command *f);
684 /** Send a modechange.
685 * The parameters provided are identical to that sent to the
686 * handler for class cmd_mode.
687 * @param parameters The mode parameters
688 * @param pcnt The number of items you have given in the first parameter
689 * @param user The user to send error messages to
691 void SendMode(const std::vector<std::string>& parameters, User *user);
693 /** Match two strings using pattern matching.
694 * This operates identically to the global function match(),
695 * except for that it takes std::string arguments rather than
697 * @param sliteral The literal string to match against
698 * @param spattern The pattern to match against. CIDR and globs are supported.
700 bool MatchText(const std::string &sliteral, const std::string &spattern);
702 /** Call the handler for a given command.
703 * @param commandname The command whos handler you wish to call
704 * @param parameters The mode parameters
705 * @param pcnt The number of items you have given in the first parameter
706 * @param user The user to execute the command as
707 * @return True if the command handler was called successfully
709 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
711 /** Return true if the command is a module-implemented command and the given parameters are valid for it
712 * @param parameters The mode parameters
713 * @param pcnt The number of items you have given in the first parameter
714 * @param user The user to test-execute the command as
715 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
717 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
719 /** Return true if the given parameter is a valid nick!user\@host mask
720 * @param mask A nick!user\@host masak to match against
721 * @return True i the mask is valid
723 bool IsValidMask(const std::string &mask);
725 /** Rehash the local server
729 /** Return the channel whos index number matches that provided
730 * @param The index number of the channel to fetch
731 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
733 Channel* GetChannelIndex(long index);
735 /** Dump text to a user target, splitting it appropriately to fit
736 * @param User the user to dump the text to
737 * @param LinePrefix text to prefix each complete line with
738 * @param TextStream the text to send to the user
740 void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream);
742 /** Check if the given nickmask matches too many users, send errors to the given user
743 * @param nick A nickmask to match against
744 * @param user A user to send error text to
745 * @return True if the nick matches too many users
747 bool NickMatchesEveryone(const std::string &nick, User* user);
749 /** Check if the given IP mask matches too many users, send errors to the given user
750 * @param ip An ipmask to match against
751 * @param user A user to send error text to
752 * @return True if the ip matches too many users
754 bool IPMatchesEveryone(const std::string &ip, User* user);
756 /** Check if the given hostmask matches too many users, send errors to the given user
757 * @param mask A hostmask to match against
758 * @param user A user to send error text to
759 * @return True if the host matches too many users
761 bool HostMatchesEveryone(const std::string &mask, User* user);
763 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
764 * @param str A string containing a time in the form 1y2w3d4h6m5s
765 * (one year, two weeks, three days, four hours, six minutes and five seconds)
766 * @return The total number of seconds
768 long Duration(const std::string &str);
770 /** Attempt to compare a password to a string from the config file.
771 * This will be passed to handling modules which will compare the data
772 * against possible hashed equivalents in the input string.
773 * @param ex The object (user, server, whatever) causing the comparison.
774 * @param data The data from the config file
775 * @param input The data input by the oper
776 * @param hashtype The hash from the config file
777 * @return 0 if the strings match, 1 or -1 if they do not
779 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
781 /** Check if a given server is a uline.
782 * An empty string returns true, this is by design.
783 * @param server The server to check for uline status
784 * @return True if the server is a uline OR the string is empty
786 bool ULine(const char* server);
788 /** Returns true if the uline is 'silent' (doesnt generate
789 * remote connect notices etc).
791 bool SilentULine(const char* server);
793 /** Returns the subversion revision ID of this ircd
794 * @return The revision ID or an empty string
796 std::string GetRevision();
798 /** Returns the full version string of this ircd
799 * @return The version string
801 std::string GetVersionString();
803 /** Attempt to write the process id to a given file
804 * @param filename The PID file to attempt to write to
805 * @return This function may bail if the file cannot be written
807 void WritePID(const std::string &filename);
809 /** This constructor initialises all the subsystems and reads the config file.
810 * @param argc The argument count passed to main()
811 * @param argv The argument list passed to main()
812 * @throw <anything> If anything is thrown from here and makes it to
813 * you, you should probably just give up and go home. Yes, really.
814 * It's that bad. Higher level classes should catch any non-fatal exceptions.
816 InspIRCd(int argc, char** argv);
818 /** Send a line of WHOIS data to a user.
819 * @param user user to send the line to
820 * @param dest user being WHOISed
821 * @param numeric Numeric to send
822 * @param text Text of the numeric
824 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
826 /** Send a line of WHOIS data to a user.
827 * @param user user to send the line to
828 * @param dest user being WHOISed
829 * @param numeric Numeric to send
830 * @param format Format string for the numeric
831 * @param ... Parameters for the format string
833 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
835 /** Quit a user for excess flood, and if they are not
836 * fully registered yet, temporarily zline their IP.
837 * @param current user to quit
839 caller1<void, User*> FloodQuitUser;
841 /** Restart the server.
842 * This function will not return. If an error occurs,
843 * it will throw an instance of CoreException.
844 * @param reason The restart reason to show to all clients
845 * @throw CoreException An instance of CoreException indicating the error from execv().
847 void Restart(const std::string &reason);
849 /** Prepare the ircd for restart or shutdown.
850 * This function unloads all modules which can be unloaded,
851 * closes all open sockets, and closes the logfile.
855 /** This copies the user and channel hash_maps into new hash maps.
856 * This frees memory used by the hash_map allocator (which it neglects
857 * to free, most of the time, using tons of ram)
859 void RehashUsersAndChans();
861 /** Resets the cached max bans value on all channels.
866 /** Return a time_t as a human-readable string.
868 std::string TimeString(time_t curtime);
870 /** Begin execution of the server.
871 * NOTE: this function NEVER returns. Internally,
872 * it will repeatedly loop.
873 * @return The return value for this function is undefined.
877 /** Force all BufferedSockets to be removed which are due to
880 void BufferedSocketCull();
882 char* GetReadBuffer()
884 return this->ReadBuffer;