1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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__
17 #define _FILE_OFFSET_BITS 64
18 #ifndef _LARGEFILE_SOURCE
19 #define _LARGEFILE_SOURCE
25 #define printf_c printf
27 #include "inspircd_win32wrapper.h"
28 /** Windows defines these already */
34 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
36 #define CUSTOM_PRINTF(STRING, FIRST)
39 // Required system headers.
57 /** A list of failed port bindings, used for informational purposes on startup */
58 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
61 CoreExport extern InspIRCd* ServerInstance;
63 #include "inspircd_config.h"
64 #include "inspircd_version.h"
66 #include "cull_list.h"
67 #include "extensible.h"
76 #include "usermanager.h"
79 #include "command_parse.h"
81 #include "socketengine.h"
83 #include "filelogger.h"
86 #include "configreader.h"
87 #include "inspstring.h"
89 #include "threadengine.h"
93 #warning Potentially broken system, PATH_MAX undefined
98 * Used to define the maximum number of parameters a command may have.
100 #define MAXPARAMETERS 127
102 /** Returned by some functions to indicate failure.
106 /** Support for librodent -
107 * see http://www.chatspike.net/index.php?z=64
109 #define ETIREDHAMSTERS EAGAIN
111 /** Template function to convert any input type to std::string
113 template<typename T> inline std::string ConvNumeric(const T &in)
115 if (in == 0) return "0";
120 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
127 std::reverse(res,out);
131 /** Template function to convert any input type to std::string
133 inline std::string ConvToStr(const int in)
135 return ConvNumeric(in);
138 /** Template function to convert any input type to std::string
140 inline std::string ConvToStr(const long in)
142 return ConvNumeric(in);
145 /** Template function to convert any input type to std::string
147 inline std::string ConvToStr(const char* in)
152 /** Template function to convert any input type to std::string
154 inline std::string ConvToStr(const bool in)
156 return (in ? "1" : "0");
159 /** Template function to convert any input type to std::string
161 inline std::string ConvToStr(char in)
163 return std::string(in,1);
166 /** Template function to convert any input type to std::string
168 template <class T> inline std::string ConvToStr(const T &in)
170 std::stringstream tmp;
171 if (!(tmp << in)) return std::string();
175 /** Template function to convert any input type to any other type
176 * (usually an integer or numeric type)
178 template<typename T> inline long ConvToInt(const T &in)
180 std::stringstream tmp;
181 if (!(tmp << in)) return 0;
182 return atoi(tmp.str().c_str());
185 /** Template function to convert integer to char, storing result in *res and
186 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
187 * @param T input value
188 * @param V result value
189 * @param R base to convert to
191 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
193 if (base < 2 || base > 16) { *res = 0; return res; }
197 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
201 if ( in < 0 && base == 10) *out++ = '-';
202 std::reverse( res, out );
207 /** This class contains various STATS counters
208 * It is used by the InspIRCd class, which internally
209 * has an instance of it.
214 /** Number of accepted connections
216 unsigned long statsAccept;
217 /** Number of failed accepts
219 unsigned long statsRefused;
220 /** Number of unknown commands seen
222 unsigned long statsUnknown;
223 /** Number of nickname collisions handled
225 unsigned long statsCollisions;
226 /** Number of DNS queries sent out
228 unsigned long statsDns;
229 /** Number of good DNS replies received
230 * NOTE: This may not tally to the number sent out,
231 * due to timeouts and other latency issues.
233 unsigned long statsDnsGood;
234 /** Number of bad (negative) DNS replies received
235 * NOTE: This may not tally to the number sent out,
236 * due to timeouts and other latency issues.
238 unsigned long statsDnsBad;
239 /** Number of inbound connections seen
241 unsigned long statsConnects;
242 /** Total bytes of data transmitted
245 /** Total bytes of data received
248 /** Cpu usage at last sample
251 /** Time last sample was read
254 /** The constructor initializes all the counts to zero
257 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
258 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
265 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
266 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
267 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
268 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
269 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
270 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
272 /* Forward declaration - required */
274 class BanCacheManager;
276 /** The background thread for config reading, so that reading from executable includes
279 class CoreExport ConfigReaderThread : public Thread
281 ServerConfig* Config;
284 std::string TheUserUID;
285 ConfigReaderThread(const std::string &useruid)
286 : Thread(), done(false), TheUserUID(useruid)
290 virtual ~ConfigReaderThread()
295 /** Run in the main thread to apply the configuration */
297 bool IsDone() { return done; }
300 /** The main class of the irc server.
301 * This class contains instances of all the other classes in this software.
302 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
303 * object, and a list of active Module objects, and facilities for Module
304 * objects to interact with the core system it implements.
306 class CoreExport InspIRCd
309 /** Holds the current UID. Used to generate the next one.
311 char current_uid[UUID_LENGTH];
313 /** Set up the signal handlers
317 /** Daemonize the ircd and close standard input/output streams
318 * @return True if the program daemonized succesfully
322 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
323 * @param TIME the current time
325 void DoSocketTimeouts(time_t TIME);
327 /** Increments the current UID by one.
329 void IncrementUID(int pos);
331 /** Perform background user events such as PING checks
333 void DoBackgroundUserStuff();
335 /** Returns true when all modules have done pre-registration checks on a user
336 * @param user The user to verify
337 * @return True if all modules have finished checking this user
339 bool AllModulesReportReady(User* user);
341 /** Logfile pathname specified on the commandline, or empty string
343 char LogFileName[MAXBUF];
345 /** The current time, updated in the mainloop
349 /** The time that was recorded last time around the mainloop
353 /** A 64k buffer used to read socket data into
354 * NOTE: update ValidateNetBufferSize if you change this
356 char ReadBuffer[65535];
364 /** Global cull list, will be processed on next iteration
366 CullList GlobalCulls;
367 /** Actions that must happen outside of the current call stack */
368 ActionList AtomicActions;
372 IsNickHandler HandleIsNick;
373 IsIdentHandler HandleIsIdent;
374 FloodQuitUserHandler HandleFloodQuitUser;
375 IsChannelHandler HandleIsChannel;
376 IsSIDHandler HandleIsSID;
377 RehashHandler HandleRehash;
379 /** 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
382 * SendMode expects a User* to send the numeric replies
383 * back to, so we create it a fake user that isnt in the user
384 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
385 * falls into the abyss :p
387 FakeUser* FakeClient;
389 /** Returns the next available UID for this server.
391 std::string GetUID();
393 /** Find a user in the UUID hash
394 * @param nick The nickname to find
395 * @return A pointer to the user, or NULL if the user does not exist
397 User* FindUUID(const std::string &);
399 /** Find a user in the UUID hash
400 * @param nick The nickname to find
401 * @return A pointer to the user, or NULL if the user does not exist
403 User* FindUUID(const char *);
405 /** Build the ISUPPORT string by triggering all modules On005Numeric events
407 void BuildISupport();
409 /** Time this ircd was booted
413 /** Config file pathname specified on the commandline or via ./configure
415 std::string ConfigFileName;
417 ExtensionManager Extensions;
419 /** Mode handler, handles mode setting and removal
423 /** Command parser, handles client to server commands
425 CommandParser* Parser;
427 /** Socket engine, handles socket activity events
431 /** Thread engine, Handles threading where required
433 ThreadEngine* Threads;
435 /** The thread/class used to read config files in REHASH and on startup
437 ConfigReaderThread* ConfigThread;
439 /** LogManager handles logging.
443 /** ModuleManager contains everything related to loading/unloading
446 ModuleManager* Modules;
448 /** BanCacheManager is used to speed up checking of restrictions on connection
451 BanCacheManager *BanCache;
453 /** Stats class, holds miscellaneous stats counters
457 /** Server Config class, holds configuration file data
459 ServerConfig* Config;
461 /** Snomask manager - handles routing of snomask messages
466 /** DNS class, provides resolver facilities to the core and modules
470 /** Timer manager class, triggers Timer timer events
472 TimerManager* Timers;
474 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
476 XLineManager* XLines;
478 /** User manager. Various methods and data associated with users.
482 /** Channel list, a hash_map containing all channels XXX move to channel manager class
486 /** List of the open ports
488 std::vector<ListenSocketBase *> ports;
490 /** Set to the current signal recieved
494 /** Protocol interface, overridden by server protocol modules
496 ProtocolInterface* PI;
498 /** Holds extensible for user nickforced
500 LocalIntExt NICKForced;
502 /** Holds extensible for user operquit
504 LocalStringExt OperQuit;
506 /** Get the current time
507 * Because this only calls time() once every time around the mainloop,
508 * it is much faster than calling time() directly.
509 * @return The current time as an epoch value (time_t)
513 /** Bind all ports specified in the configuration file.
514 * @return The number of ports bound without error
516 int BindPorts(FailedPortList &failed_ports);
518 /** Binds a socket on an already open file descriptor
519 * @param sockfd A valid file descriptor of an open socket
520 * @param port The port number to bind to
521 * @param addr The address to bind to (IP only)
522 * @return True if the port was bound successfully
524 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
526 /** Gets the GECOS (description) field of the given server.
527 * If the servername is not that of the local server, the name
528 * is passed to handling modules which will attempt to determine
529 * the GECOS that bleongs to the given servername.
530 * @param servername The servername to find the description of
531 * @return The description of this server, or of the local server
533 std::string GetServerDescription(const std::string& servername);
535 /** Find a user in the nick hash.
536 * If the user cant be found in the nick hash check the uuid hash
537 * @param nick The nickname to find
538 * @return A pointer to the user, or NULL if the user does not exist
540 User* FindNick(const std::string &nick);
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 char* nick);
549 /** Find a user in the nick hash ONLY
551 User* FindNickOnly(const char* nick);
553 /** Find a user in the nick hash ONLY
555 User* FindNickOnly(const std::string &nick);
557 /** Find a channel in the channels hash
558 * @param chan The channel to find
559 * @return A pointer to the channel, or NULL if the channel does not exist
561 Channel* FindChan(const std::string &chan);
563 /** Find a channel in the channels hash
564 * @param chan The channel to find
565 * @return A pointer to the channel, or NULL if the channel does not exist
567 Channel* FindChan(const char* chan);
569 /** Check we aren't running as root, and exit if we are
570 * @return Depending on the configuration, this function may never return
574 /** Determine the right path for, and open, the logfile
575 * @param argv The argv passed to main() initially, used to calculate program path
576 * @param argc The argc passed to main() initially, used to calculate program path
577 * @return True if the log could be opened, false if otherwise
579 bool OpenLog(char** argv, int argc);
581 /** Return true if a channel name is valid
582 * @param chname A channel name to verify
583 * @return True if the name is valid
585 caller2<bool, const char*, size_t> IsChannel;
587 /** Return true if str looks like a server ID
588 * @param string to check against
590 caller1<bool, const std::string&> IsSID;
592 /** Rehash the local server
594 caller1<void, const std::string&> Rehash;
596 /** Handles incoming signals after being set
597 * @param signal the signal recieved
599 void SignalHandler(int signal);
601 /** Sets the signal recieved
602 * @param signal the signal recieved
604 static void SetSignal(int signal);
606 /** Causes the server to exit after unloading modules and
607 * closing all open file descriptors.
609 * @param The exit code to give to the operating system
610 * (See the ExitStatus enum for valid values)
612 void Exit(int status);
614 /** Causes the server to exit immediately with exit code 0.
615 * The status code is required for signal handlers, and ignored.
617 static void QuickExit(int status);
619 /** Return a count of channels on the network
620 * @return The number of channels
624 /** Send an error notice to all local users, opered and unopered
625 * @param s The error string to send
627 void SendError(const std::string &s);
629 /** Return true if a nickname is valid
630 * @param n A nickname to verify
631 * @return True if the nick is valid
633 caller2<bool, const char*, size_t> IsNick;
635 /** Return true if an ident is valid
636 * @param An ident to verify
637 * @return True if the ident is valid
639 caller1<bool, const char*> IsIdent;
641 /** Add a dns Resolver class to this server's active set
642 * @param r The resolver to add
643 * @param cached If this value is true, then the cache will
644 * be searched for the DNS result, immediately. If the value is
645 * false, then a request will be sent to the nameserver, and the
646 * result will not be immediately available. You should usually
647 * use the boolean value which you passed to the Resolver
648 * constructor, which Resolver will set appropriately depending
649 * on if cached results are available and haven't expired. It is
650 * however safe to force this value to false, forcing a remote DNS
651 * lookup, but not an update of the cache.
652 * @return True if the operation completed successfully. Note that
653 * if this method returns true, you should not attempt to access
654 * the resolver class you pass it after this call, as depending upon
655 * the request given, the object may be deleted!
657 bool AddResolver(Resolver* r, bool cached);
659 /** Add a command to this server's command parser
660 * @param f A Command command handler object to add
661 * @throw ModuleException Will throw ModuleExcption if the command already exists
663 void AddCommand(Command *f);
665 /** Send a modechange.
666 * The parameters provided are identical to that sent to the
667 * handler for class cmd_mode.
668 * @param parameters The mode parameters
669 * @param user The user to send error messages to
671 void SendMode(const std::vector<std::string>& parameters, User *user);
673 /** Match two strings using pattern matching, optionally, with a map
674 * to check case against (may be NULL). If map is null, match will be case insensitive.
675 * @param str The literal string to match against
676 * @param mask The glob pattern to match against.
678 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
679 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
681 /** Match two strings using pattern matching, optionally, with a map
682 * to check case against (may be NULL). If map is null, match will be case insensitive.
683 * Supports CIDR patterns as well as globs.
684 * @param str The literal string to match against
685 * @param mask The glob or CIDR pattern to match against.
687 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
688 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
690 /** Call the handler for a given command.
691 * @param commandname The command whos handler you wish to call
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 execute the command as
695 * @return True if the command handler was called successfully
697 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
699 /** Return true if the command is a module-implemented command and the given parameters are valid for it
700 * @param parameters The mode parameters
701 * @param pcnt The number of items you have given in the first parameter
702 * @param user The user to test-execute the command as
703 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
705 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
707 /** Return true if the given parameter is a valid nick!user\@host mask
708 * @param mask A nick!user\@host masak to match against
709 * @return True i the mask is valid
711 bool IsValidMask(const std::string &mask);
713 /** Rehash the local server
717 /** Check if the given nickmask matches too many users, send errors to the given user
718 * @param nick A nickmask to match against
719 * @param user A user to send error text to
720 * @return True if the nick matches too many users
722 bool NickMatchesEveryone(const std::string &nick, User* user);
724 /** Check if the given IP mask matches too many users, send errors to the given user
725 * @param ip An ipmask to match against
726 * @param user A user to send error text to
727 * @return True if the ip matches too many users
729 bool IPMatchesEveryone(const std::string &ip, User* user);
731 /** Check if the given hostmask matches too many users, send errors to the given user
732 * @param mask A hostmask to match against
733 * @param user A user to send error text to
734 * @return True if the host matches too many users
736 bool HostMatchesEveryone(const std::string &mask, User* user);
738 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
739 * @param str A string containing a time in the form 1y2w3d4h6m5s
740 * (one year, two weeks, three days, four hours, six minutes and five seconds)
741 * @return The total number of seconds
743 long Duration(const std::string &str);
745 /** Attempt to compare a password to a string from the config file.
746 * This will be passed to handling modules which will compare the data
747 * against possible hashed equivalents in the input string.
748 * @param ex The object (user, server, whatever) causing the comparison.
749 * @param data The data from the config file
750 * @param input The data input by the oper
751 * @param hashtype The hash from the config file
752 * @return 0 if the strings match, 1 or -1 if they do not
754 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
756 /** Check if a given server is a uline.
757 * An empty string returns true, this is by design.
758 * @param server The server to check for uline status
759 * @return True if the server is a uline OR the string is empty
761 bool ULine(const std::string& server);
763 /** Returns true if the uline is 'silent' (doesnt generate
764 * remote connect notices etc).
766 bool SilentULine(const std::string& server);
768 /** Returns the subversion revision ID of this ircd
769 * @return The revision ID or an empty string
771 std::string GetRevision();
773 /** Returns the full version string of this ircd
774 * @return The version string
776 std::string GetVersionString();
778 /** Attempt to write the process id to a given file
779 * @param filename The PID file to attempt to write to
780 * @return This function may bail if the file cannot be written
782 void WritePID(const std::string &filename);
784 /** This constructor initialises all the subsystems and reads the config file.
785 * @param argc The argument count passed to main()
786 * @param argv The argument list passed to main()
787 * @throw <anything> If anything is thrown from here and makes it to
788 * you, you should probably just give up and go home. Yes, really.
789 * It's that bad. Higher level classes should catch any non-fatal exceptions.
791 InspIRCd(int argc, char** argv);
793 /** Send a line of WHOIS data to a user.
794 * @param user user to send the line to
795 * @param dest user being WHOISed
796 * @param numeric Numeric to send
797 * @param text Text of the numeric
799 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
801 /** Send a line of WHOIS data to a user.
802 * @param user user to send the line to
803 * @param dest user being WHOISed
804 * @param numeric Numeric to send
805 * @param format Format string for the numeric
806 * @param ... Parameters for the format string
808 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
812 void DoStats(char statschar, User* user, string_list &results);
816 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
818 /** Quit a user for excess flood, and if they are not
819 * fully registered yet, temporarily zline their IP.
820 * @param current user to quit
822 caller1<void, User*> FloodQuitUser;
824 /** Restart the server.
825 * This function will not return. If an error occurs,
826 * it will throw an instance of CoreException.
827 * @param reason The restart reason to show to all clients
828 * @throw CoreException An instance of CoreException indicating the error from execv().
830 void Restart(const std::string &reason);
832 /** Prepare the ircd for restart or shutdown.
833 * This function unloads all modules which can be unloaded,
834 * closes all open sockets, and closes the logfile.
838 /** This copies the user and channel hash_maps into new hash maps.
839 * This frees memory used by the hash_map allocator (which it neglects
840 * to free, most of the time, using tons of ram)
842 void RehashUsersAndChans();
844 /** Resets the cached max bans value on all channels.
849 /** Return a time_t as a human-readable string.
851 std::string TimeString(time_t curtime);
853 /** Begin execution of the server.
854 * NOTE: this function NEVER returns. Internally,
855 * it will repeatedly loop.
856 * @return The return value for this function is undefined.
860 /** Adds an extban char to the 005 token.
862 void AddExtBanChar(char c);
864 char* GetReadBuffer()
866 return this->ReadBuffer;
873 class CommandModule : public Module
877 CommandModule() : cmd(this)
879 ServerInstance->AddCommand(&cmd);
884 return Version(cmd.command, VF_VENDOR|VF_CORE);