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;
60 /** A cached text file stored with its contents as lines
62 typedef std::deque< std::string > file_cache;
64 /** A configuration key and value pair
66 typedef std::pair< std::string, std::string > KeyVal;
68 /** A list of related configuration keys and values
70 typedef std::vector< KeyVal > KeyValList;
72 /** An entire config file, built up of KeyValLists
74 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
77 CoreExport extern InspIRCd* ServerInstance;
79 #include "inspircd_config.h"
80 #include "inspircd_version.h"
81 #include "extensible.h"
90 #include "usermanager.h"
93 #include "command_parse.h"
95 #include "socketengine.h"
97 #include "cull_list.h"
98 #include "filelogger.h"
101 #include "configreader.h"
102 #include "inspstring.h"
103 #include "protocol.h"
104 #include "threadengine.h"
105 #include "fakeuser.h"
108 #warning Potentially broken system, PATH_MAX undefined
109 #define PATH_MAX 4096
113 * Used to define the maximum number of parameters a command may have.
115 #define MAXPARAMETERS 127
117 /** Returned by some functions to indicate failure.
121 /** Support for librodent -
122 * see http://www.chatspike.net/index.php?z=64
124 #define ETIREDHAMSTERS EAGAIN
126 /** Template function to convert any input type to std::string
128 template<typename T> inline std::string ConvNumeric(const T &in)
130 if (in == 0) return "0";
135 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
142 std::reverse(res,out);
146 /** Template function to convert any input type to std::string
148 inline std::string ConvToStr(const int in)
150 return ConvNumeric(in);
153 /** Template function to convert any input type to std::string
155 inline std::string ConvToStr(const long in)
157 return ConvNumeric(in);
160 /** Template function to convert any input type to std::string
162 inline std::string ConvToStr(const char* in)
167 /** Template function to convert any input type to std::string
169 inline std::string ConvToStr(const bool in)
171 return (in ? "1" : "0");
174 /** Template function to convert any input type to std::string
176 inline std::string ConvToStr(char in)
178 return std::string(in,1);
181 /** Template function to convert any input type to std::string
183 template <class T> inline std::string ConvToStr(const T &in)
185 std::stringstream tmp;
186 if (!(tmp << in)) return std::string();
190 /** Template function to convert any input type to any other type
191 * (usually an integer or numeric type)
193 template<typename T> inline long ConvToInt(const T &in)
195 std::stringstream tmp;
196 if (!(tmp << in)) return 0;
197 return atoi(tmp.str().c_str());
200 /** Template function to convert integer to char, storing result in *res and
201 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
202 * @param T input value
203 * @param V result value
204 * @param R base to convert to
206 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
208 if (base < 2 || base > 16) { *res = 0; return res; }
212 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
216 if ( in < 0 && base == 10) *out++ = '-';
217 std::reverse( res, out );
222 /** This class contains various STATS counters
223 * It is used by the InspIRCd class, which internally
224 * has an instance of it.
226 class serverstats : public classbase
229 /** Number of accepted connections
231 unsigned long statsAccept;
232 /** Number of failed accepts
234 unsigned long statsRefused;
235 /** Number of unknown commands seen
237 unsigned long statsUnknown;
238 /** Number of nickname collisions handled
240 unsigned long statsCollisions;
241 /** Number of DNS queries sent out
243 unsigned long statsDns;
244 /** Number of good DNS replies received
245 * NOTE: This may not tally to the number sent out,
246 * due to timeouts and other latency issues.
248 unsigned long statsDnsGood;
249 /** Number of bad (negative) DNS replies received
250 * NOTE: This may not tally to the number sent out,
251 * due to timeouts and other latency issues.
253 unsigned long statsDnsBad;
254 /** Number of inbound connections seen
256 unsigned long statsConnects;
257 /** Total bytes of data transmitted
260 /** Total bytes of data received
263 /** Cpu usage at last sample
266 /** Time last sample was read
269 /** The constructor initializes all the counts to zero
272 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
273 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
280 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
281 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
282 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
283 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
284 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
285 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
287 /* Forward declaration - required */
289 class BanCacheManager;
291 /** The background thread for config reading, so that reading from executable includes
294 class CoreExport ConfigReaderThread : public Thread
296 ServerConfig* Config;
299 std::string TheUserUID;
300 ConfigReaderThread(const std::string &useruid)
301 : Thread(), done(false), TheUserUID(useruid)
305 virtual ~ConfigReaderThread()
310 /** Run in the main thread to apply the configuration */
312 bool IsDone() { return done; }
315 /** The main class of the irc server.
316 * This class contains instances of all the other classes
317 * in this software, with the exception of the base class,
318 * classbase. Amongst other things, it contains a ModeParser,
319 * a DNS object, a CommandParser object, and a list of active
320 * Module objects, and facilities for Module objects to
321 * interact with the core system it implements.
323 class CoreExport InspIRCd : public classbase
326 /** Holds the current UID. Used to generate the next one.
328 char current_uid[UUID_LENGTH];
330 /** Set up the signal handlers
334 /** Daemonize the ircd and close standard input/output streams
335 * @return True if the program daemonized succesfully
339 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
340 * @param TIME the current time
342 void DoSocketTimeouts(time_t TIME);
344 /** Increments the current UID by one.
346 void IncrementUID(int pos);
348 /** Perform background user events such as PING checks
350 void DoBackgroundUserStuff();
352 /** Returns true when all modules have done pre-registration checks on a user
353 * @param user The user to verify
354 * @return True if all modules have finished checking this user
356 bool AllModulesReportReady(User* user);
358 /** Logfile pathname specified on the commandline, or empty string
360 char LogFileName[MAXBUF];
362 /** The current time, updated in the mainloop
366 /** The time that was recorded last time around the mainloop
370 /** A 64k buffer used to read socket data into
371 * NOTE: update ValidateNetBufferSize if you change this
373 char ReadBuffer[65535];
381 /** Global cull list, will be processed on next iteration
383 CullList GlobalCulls;
387 IsNickHandler HandleIsNick;
388 IsIdentHandler HandleIsIdent;
389 FloodQuitUserHandler HandleFloodQuitUser;
390 IsChannelHandler HandleIsChannel;
391 IsSIDHandler HandleIsSID;
392 RehashHandler HandleRehash;
394 /** 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
397 * SendMode expects a User* to send the numeric replies
398 * back to, so we create it a fake user that isnt in the user
399 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
400 * falls into the abyss :p
402 FakeUser* FakeClient;
404 /** Returns the next available UID for this server.
406 std::string GetUID();
408 /** Find a user in the UUID hash
409 * @param nick The nickname to find
410 * @return A pointer to the user, or NULL if the user does not exist
412 User* FindUUID(const std::string &);
414 /** Find a user in the UUID hash
415 * @param nick The nickname to find
416 * @return A pointer to the user, or NULL if the user does not exist
418 User* FindUUID(const char *);
420 /** Build the ISUPPORT string by triggering all modules On005Numeric events
422 void BuildISupport();
424 /** Time this ircd was booted
428 /** Config file pathname specified on the commandline or via ./configure
430 std::string ConfigFileName;
432 /** Mode handler, handles mode setting and removal
436 /** Command parser, handles client to server commands
438 CommandParser* Parser;
440 /** Socket engine, handles socket activity events
444 /** Thread engine, Handles threading where required
446 ThreadEngine* Threads;
448 /** The thread/class used to read config files in REHASH and on startup
450 ConfigReaderThread* ConfigThread;
452 /** LogManager handles logging.
456 /** ModuleManager contains everything related to loading/unloading
459 ModuleManager* Modules;
461 /** BanCacheManager is used to speed up checking of restrictions on connection
464 BanCacheManager *BanCache;
466 /** Stats class, holds miscellaneous stats counters
470 /** Server Config class, holds configuration file data
472 ServerConfig* Config;
474 /** Snomask manager - handles routing of snomask messages
479 /** DNS class, provides resolver facilities to the core and modules
483 /** Timer manager class, triggers Timer timer events
485 TimerManager* Timers;
487 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
489 XLineManager* XLines;
491 /** User manager. Various methods and data associated with users.
495 /** Channel list, a hash_map containing all channels XXX move to channel manager class
499 /** List of the open ports
501 std::vector<ListenSocketBase *> ports;
503 /** Set to the current signal recieved
507 /** Protocol interface, overridden by server protocol modules
509 ProtocolInterface* PI;
511 /** Get the current time
512 * Because this only calls time() once every time around the mainloop,
513 * it is much faster than calling time() directly.
514 * @return The current time as an epoch value (time_t)
518 /** Bind all ports specified in the configuration file.
519 * @return The number of ports bound without error
521 int BindPorts(FailedPortList &failed_ports);
523 /** Binds a socket on an already open file descriptor
524 * @param sockfd A valid file descriptor of an open socket
525 * @param port The port number to bind to
526 * @param addr The address to bind to (IP only)
527 * @return True if the port was bound successfully
529 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
531 /** Gets the GECOS (description) field of the given server.
532 * If the servername is not that of the local server, the name
533 * is passed to handling modules which will attempt to determine
534 * the GECOS that bleongs to the given servername.
535 * @param servername The servername to find the description of
536 * @return The description of this server, or of the local server
538 std::string GetServerDescription(const std::string& servername);
540 /** Find a user in the nick hash.
541 * If the user cant be found in the nick hash check the uuid hash
542 * @param nick The nickname to find
543 * @return A pointer to the user, or NULL if the user does not exist
545 User* FindNick(const std::string &nick);
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 char* nick);
554 /** Find a user in the nick hash ONLY
556 User* FindNickOnly(const char* nick);
558 /** Find a user in the nick hash ONLY
560 User* FindNickOnly(const std::string &nick);
562 /** Find a channel in the channels hash
563 * @param chan The channel to find
564 * @return A pointer to the channel, or NULL if the channel does not exist
566 Channel* FindChan(const std::string &chan);
568 /** Find a channel in the channels hash
569 * @param chan The channel to find
570 * @return A pointer to the channel, or NULL if the channel does not exist
572 Channel* FindChan(const char* chan);
574 /** Check we aren't running as root, and exit if we are
575 * @return Depending on the configuration, this function may never return
579 /** Determine the right path for, and open, the logfile
580 * @param argv The argv passed to main() initially, used to calculate program path
581 * @param argc The argc passed to main() initially, used to calculate program path
582 * @return True if the log could be opened, false if otherwise
584 bool OpenLog(char** argv, int argc);
586 /** Return true if a channel name is valid
587 * @param chname A channel name to verify
588 * @return True if the name is valid
590 caller2<bool, const char*, size_t> IsChannel;
592 /** Return true if str looks like a server ID
593 * @param string to check against
595 caller1<bool, const std::string&> IsSID;
597 /** Rehash the local server
599 caller1<void, const std::string&> Rehash;
601 /** Handles incoming signals after being set
602 * @param signal the signal recieved
604 void SignalHandler(int signal);
606 /** Sets the signal recieved
607 * @param signal the signal recieved
609 static void SetSignal(int signal);
611 /** Causes the server to exit after unloading modules and
612 * closing all open file descriptors.
614 * @param The exit code to give to the operating system
615 * (See the ExitStatus enum for valid values)
617 void Exit(int status);
619 /** Causes the server to exit immediately with exit code 0.
620 * The status code is required for signal handlers, and ignored.
622 static void QuickExit(int status);
624 /** Return a count of channels on the network
625 * @return The number of channels
629 /** Send an error notice to all local users, opered and unopered
630 * @param s The error string to send
632 void SendError(const std::string &s);
634 /** Return true if a nickname is valid
635 * @param n A nickname to verify
636 * @return True if the nick is valid
638 caller2<bool, const char*, size_t> IsNick;
640 /** Return true if an ident is valid
641 * @param An ident to verify
642 * @return True if the ident is valid
644 caller1<bool, const char*> IsIdent;
646 /** Add a dns Resolver class to this server's active set
647 * @param r The resolver to add
648 * @param cached If this value is true, then the cache will
649 * be searched for the DNS result, immediately. If the value is
650 * false, then a request will be sent to the nameserver, and the
651 * result will not be immediately available. You should usually
652 * use the boolean value which you passed to the Resolver
653 * constructor, which Resolver will set appropriately depending
654 * on if cached results are available and haven't expired. It is
655 * however safe to force this value to false, forcing a remote DNS
656 * lookup, but not an update of the cache.
657 * @return True if the operation completed successfully. Note that
658 * if this method returns true, you should not attempt to access
659 * the resolver class you pass it after this call, as depending upon
660 * the request given, the object may be deleted!
662 bool AddResolver(Resolver* r, bool cached);
664 /** Add a command to this server's command parser
665 * @param f A Command command handler object to add
666 * @throw ModuleException Will throw ModuleExcption if the command already exists
668 void AddCommand(Command *f);
670 /** Send a modechange.
671 * The parameters provided are identical to that sent to the
672 * handler for class cmd_mode.
673 * @param parameters The mode parameters
674 * @param user The user to send error messages to
676 void SendMode(const std::vector<std::string>& parameters, User *user);
678 /** Match two strings using pattern matching, optionally, with a map
679 * to check case against (may be NULL). If map is null, match will be case insensitive.
680 * @param str The literal string to match against
681 * @param mask The glob pattern to match against.
683 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
684 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
686 /** Match two strings using pattern matching, optionally, with a map
687 * to check case against (may be NULL). If map is null, match will be case insensitive.
688 * Supports CIDR patterns as well as globs.
689 * @param str The literal string to match against
690 * @param mask The glob or CIDR pattern to match against.
692 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
693 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
695 /** Call the handler for a given command.
696 * @param commandname The command whos handler you wish to call
697 * @param parameters The mode parameters
698 * @param pcnt The number of items you have given in the first parameter
699 * @param user The user to execute the command as
700 * @return True if the command handler was called successfully
702 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
704 /** Return true if the command is a module-implemented command and the given parameters are valid for it
705 * @param parameters The mode parameters
706 * @param pcnt The number of items you have given in the first parameter
707 * @param user The user to test-execute the command as
708 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
710 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
712 /** Return true if the given parameter is a valid nick!user\@host mask
713 * @param mask A nick!user\@host masak to match against
714 * @return True i the mask is valid
716 bool IsValidMask(const std::string &mask);
718 /** Rehash the local server
722 /** Return the channel whos index number matches that provided
723 * @param The index number of the channel to fetch
724 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
726 Channel* GetChannelIndex(long index);
728 /** Dump text to a user target, splitting it appropriately to fit
729 * @param User the user to dump the text to
730 * @param LinePrefix text to prefix each complete line with
731 * @param TextStream the text to send to the user
733 void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream);
735 /** Dump text to a user target (local or remote)
736 * @param user the user to dump the text to
737 * @param text the full line of text
739 void DumpText(User* user, const std::string &text);
741 /** Dump text to a user target (local or remote)
742 * @param user the user to dump the text to
743 * @param format the printf format string for the text to send
745 void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
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 std::string& server);
793 /** Returns true if the uline is 'silent' (doesnt generate
794 * remote connect notices etc).
796 bool SilentULine(const std::string& 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);
842 void DoStats(char statschar, User* user, string_list &results);
846 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
848 /** Quit a user for excess flood, and if they are not
849 * fully registered yet, temporarily zline their IP.
850 * @param current user to quit
852 caller1<void, User*> FloodQuitUser;
854 /** Restart the server.
855 * This function will not return. If an error occurs,
856 * it will throw an instance of CoreException.
857 * @param reason The restart reason to show to all clients
858 * @throw CoreException An instance of CoreException indicating the error from execv().
860 void Restart(const std::string &reason);
862 /** Prepare the ircd for restart or shutdown.
863 * This function unloads all modules which can be unloaded,
864 * closes all open sockets, and closes the logfile.
868 /** This copies the user and channel hash_maps into new hash maps.
869 * This frees memory used by the hash_map allocator (which it neglects
870 * to free, most of the time, using tons of ram)
872 void RehashUsersAndChans();
874 /** Resets the cached max bans value on all channels.
879 /** Return a time_t as a human-readable string.
881 std::string TimeString(time_t curtime);
883 /** Begin execution of the server.
884 * NOTE: this function NEVER returns. Internally,
885 * it will repeatedly loop.
886 * @return The return value for this function is undefined.
890 /** Adds an extban char to the 005 token.
892 void AddExtBanChar(char c);
894 char* GetReadBuffer()
896 return this->ReadBuffer;
903 class CommandModule : public Module
907 CommandModule() : cmd(this)
909 ServerInstance->AddCommand(&cmd);
914 return Version(cmd.command, VF_VENDOR|VF_CORE);