1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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 */
33 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
35 #define CUSTOM_PRINTF(STRING, FIRST)
38 // Required system headers.
56 #include "inspircd_config.h"
57 #include "inspircd_version.h"
60 CoreExport extern InspIRCd* ServerInstance;
63 #include "cull_list.h"
64 #include "extensible.h"
72 #include "usermanager.h"
75 #include "command_parse.h"
77 #include "socketengine.h"
79 #include "filelogger.h"
82 #include "threadengine.h"
83 #include "configreader.h"
84 #include "inspstring.h"
88 #warning Potentially broken system, PATH_MAX undefined
93 * Used to define the maximum number of parameters a command may have.
95 #define MAXPARAMETERS 127
97 /** Returned by some functions to indicate failure.
101 /** Support for librodent -
102 * see http://www.chatspike.net/index.php?z=64
104 #define ETIREDHAMSTERS EAGAIN
106 /** Template function to convert any input type to std::string
108 template<typename T> inline std::string ConvNumeric(const T &in)
110 if (in == 0) return "0";
115 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
122 std::reverse(res,out);
126 /** Template function to convert any input type to std::string
128 inline std::string ConvToStr(const int in)
130 return ConvNumeric(in);
133 /** Template function to convert any input type to std::string
135 inline std::string ConvToStr(const long in)
137 return ConvNumeric(in);
140 /** Template function to convert any input type to std::string
142 inline std::string ConvToStr(const char* in)
147 /** Template function to convert any input type to std::string
149 inline std::string ConvToStr(const bool in)
151 return (in ? "1" : "0");
154 /** Template function to convert any input type to std::string
156 inline std::string ConvToStr(char in)
158 return std::string(in,1);
161 /** Template function to convert any input type to std::string
163 template <class T> inline std::string ConvToStr(const T &in)
165 std::stringstream tmp;
166 if (!(tmp << in)) return std::string();
170 /** Template function to convert any input type to any other type
171 * (usually an integer or numeric type)
173 template<typename T> inline long ConvToInt(const T &in)
175 std::stringstream tmp;
176 if (!(tmp << in)) return 0;
177 return atol(tmp.str().c_str());
180 /** This class contains various STATS counters
181 * It is used by the InspIRCd class, which internally
182 * has an instance of it.
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
217 unsigned long statsSent;
218 /** Total bytes of data received
220 unsigned long statsRecv;
221 /** Cpu usage at last sample
224 /** Time last sample was read
226 timespec LastSampled;
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 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
237 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
238 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
239 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
240 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
241 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
242 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
244 /** The main class of the irc server.
245 * This class contains instances of all the other classes in this software.
246 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
247 * object, and a list of active Module objects, and facilities for Module
248 * objects to interact with the core system it implements.
250 class CoreExport InspIRCd
253 /** Holds the current UID. Used to generate the next one.
255 char current_uid[UUID_LENGTH];
257 /** Set up the signal handlers
261 /** Daemonize the ircd and close standard input/output streams
262 * @return True if the program daemonized succesfully
266 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
267 * @param TIME the current time
269 void DoSocketTimeouts(time_t TIME);
271 /** Increments the current UID by one.
273 void IncrementUID(int pos);
275 /** Perform background user events such as PING checks
277 void DoBackgroundUserStuff();
279 /** Returns true when all modules have done pre-registration checks on a user
280 * @param user The user to verify
281 * @return True if all modules have finished checking this user
283 bool AllModulesReportReady(LocalUser* user);
285 /** The current time, updated in the mainloop
287 struct timespec TIME;
289 /** A 64k buffer used to read socket data into
290 * NOTE: update ValidateNetBufferSize if you change this
292 char ReadBuffer[65535];
300 /** Global cull list, will be processed on next iteration
302 CullList GlobalCulls;
303 /** Actions that must happen outside of the current call stack */
304 ActionList AtomicActions;
308 IsNickHandler HandleIsNick;
309 IsIdentHandler HandleIsIdent;
310 FloodQuitUserHandler HandleFloodQuitUser;
311 IsChannelHandler HandleIsChannel;
312 IsSIDHandler HandleIsSID;
313 RehashHandler HandleRehash;
314 GenRandomHandler HandleGenRandom;
316 /** 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
319 * SendMode expects a User* to send the numeric replies
320 * back to, so we create it a fake user that isnt in the user
321 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
322 * falls into the abyss :p
324 FakeUser* FakeClient;
326 /** Returns the next available UID for this server.
328 std::string GetUID();
330 /** Find a user in the UUID hash
331 * @param nick The nickname to find
332 * @return A pointer to the user, or NULL if the user does not exist
334 User* FindUUID(const std::string &);
336 /** Find a user in the UUID hash
337 * @param nick The nickname to find
338 * @return A pointer to the user, or NULL if the user does not exist
340 User* FindUUID(const char *);
342 /** Build the ISUPPORT string by triggering all modules On005Numeric events
344 void BuildISupport();
346 /** Time this ircd was booted
350 /** Config file pathname specified on the commandline or via ./configure
352 std::string ConfigFileName;
354 ExtensionManager Extensions;
356 /** Mode handler, handles mode setting and removal
360 /** Command parser, handles client to server commands
362 CommandParser* Parser;
364 /** Socket engine, handles socket activity events
368 /** Thread engine, Handles threading where required
370 ThreadEngine* Threads;
372 /** The thread/class used to read config files in REHASH and on startup
374 ConfigReaderThread* ConfigThread;
376 /** LogManager handles logging.
380 /** ModuleManager contains everything related to loading/unloading
383 ModuleManager* Modules;
385 /** BanCacheManager is used to speed up checking of restrictions on connection
388 BanCacheManager *BanCache;
390 /** Stats class, holds miscellaneous stats counters
394 /** Server Config class, holds configuration file data
396 ServerConfig* Config;
398 /** Snomask manager - handles routing of snomask messages
403 /** DNS class, provides resolver facilities to the core and modules
407 /** Timer manager class, triggers Timer timer events
409 TimerManager* Timers;
411 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
413 XLineManager* XLines;
415 /** User manager. Various methods and data associated with users.
419 /** Channel list, a hash_map containing all channels XXX move to channel manager class
423 /** List of the open ports
425 std::vector<ListenSocket*> ports;
427 /** Set to the current signal recieved
431 /** Protocol interface, overridden by server protocol modules
433 ProtocolInterface* PI;
435 /** Holds extensible for user nickforced
437 LocalIntExt NICKForced;
439 /** Holds extensible for user operquit
441 LocalStringExt OperQuit;
443 /** Get the current time
444 * Because this only calls time() once every time around the mainloop,
445 * it is much faster than calling time() directly.
446 * @return The current time as an epoch value (time_t)
448 inline time_t Time() { return TIME.tv_sec; }
449 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
450 inline long Time_ns() { return TIME.tv_nsec; }
451 /** Update the current time. Don't call this unless you have reason to do so. */
454 /** Generate a random string with the given length
455 * @param length The length in bytes
456 * @param printable if false, the string will use characters 0-255; otherwise,
457 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
459 std::string GenRandomStr(int length, bool printable = true);
460 /** Generate a random integer.
461 * This is generally more secure than rand()
463 unsigned long GenRandomInt(unsigned long max);
465 /** Fill a buffer with random bits */
466 caller2<void, char*, size_t> GenRandom;
468 /** Bind all ports specified in the configuration file.
469 * @return The number of ports bound without error
471 int BindPorts(FailedPortList &failed_ports);
473 /** Binds a socket on an already open file descriptor
474 * @param sockfd A valid file descriptor of an open socket
475 * @param port The port number to bind to
476 * @param addr The address to bind to (IP only)
477 * @return True if the port was bound successfully
479 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
481 /** Gets the GECOS (description) field of the given server.
482 * If the servername is not that of the local server, the name
483 * is passed to handling modules which will attempt to determine
484 * the GECOS that bleongs to the given servername.
485 * @param servername The servername to find the description of
486 * @return The description of this server, or of the local server
488 std::string GetServerDescription(const std::string& servername);
490 /** Find a user in the nick hash.
491 * If the user cant be found in the nick hash check the uuid hash
492 * @param nick The nickname to find
493 * @return A pointer to the user, or NULL if the user does not exist
495 User* FindNick(const std::string &nick);
497 /** Find a user in the nick hash.
498 * If the user cant be found in the nick hash check the uuid hash
499 * @param nick The nickname to find
500 * @return A pointer to the user, or NULL if the user does not exist
502 User* FindNick(const char* nick);
504 /** Find a user in the nick hash ONLY
506 User* FindNickOnly(const char* nick);
508 /** Find a user in the nick hash ONLY
510 User* FindNickOnly(const std::string &nick);
512 /** Find a channel in the channels hash
513 * @param chan The channel to find
514 * @return A pointer to the channel, or NULL if the channel does not exist
516 Channel* FindChan(const std::string &chan);
518 /** Find a channel in the channels hash
519 * @param chan The channel to find
520 * @return A pointer to the channel, or NULL if the channel does not exist
522 Channel* FindChan(const char* chan);
524 /** Check we aren't running as root, and exit if we are
525 * @return Depending on the configuration, this function may never return
529 /** Determine the right path for, and open, the logfile
530 * @param argv The argv passed to main() initially, used to calculate program path
531 * @param argc The argc passed to main() initially, used to calculate program path
532 * @return True if the log could be opened, false if otherwise
534 bool OpenLog(char** argv, int argc);
536 /** Return true if a channel name is valid
537 * @param chname A channel name to verify
538 * @return True if the name is valid
540 caller2<bool, const char*, size_t> IsChannel;
542 /** Return true if str looks like a server ID
543 * @param string to check against
545 caller1<bool, const std::string&> IsSID;
547 /** Rehash the local server
549 caller1<void, const std::string&> Rehash;
551 /** Handles incoming signals after being set
552 * @param signal the signal recieved
554 void SignalHandler(int signal);
556 /** Sets the signal recieved
557 * @param signal the signal recieved
559 static void SetSignal(int signal);
561 /** Causes the server to exit after unloading modules and
562 * closing all open file descriptors.
564 * @param The exit code to give to the operating system
565 * (See the ExitStatus enum for valid values)
567 void Exit(int status);
569 /** Causes the server to exit immediately with exit code 0.
570 * The status code is required for signal handlers, and ignored.
572 static void QuickExit(int status);
574 /** Return a count of channels on the network
575 * @return The number of channels
579 /** Send an error notice to all local users, opered and unopered
580 * @param s The error string to send
582 void SendError(const std::string &s);
584 /** Return true if a nickname is valid
585 * @param n A nickname to verify
586 * @return True if the nick is valid
588 caller2<bool, const char*, size_t> IsNick;
590 /** Return true if an ident is valid
591 * @param An ident to verify
592 * @return True if the ident is valid
594 caller1<bool, const char*> IsIdent;
596 /** Add a dns Resolver class to this server's active set
597 * @param r The resolver to add
598 * @param cached If this value is true, then the cache will
599 * be searched for the DNS result, immediately. If the value is
600 * false, then a request will be sent to the nameserver, and the
601 * result will not be immediately available. You should usually
602 * use the boolean value which you passed to the Resolver
603 * constructor, which Resolver will set appropriately depending
604 * on if cached results are available and haven't expired. It is
605 * however safe to force this value to false, forcing a remote DNS
606 * lookup, but not an update of the cache.
607 * @return True if the operation completed successfully. Note that
608 * if this method returns true, you should not attempt to access
609 * the resolver class you pass it after this call, as depending upon
610 * the request given, the object may be deleted!
612 bool AddResolver(Resolver* r, bool cached);
614 /** Add a command to this server's command parser
615 * @param f A Command command handler object to add
616 * @throw ModuleException Will throw ModuleExcption if the command already exists
618 inline void AddCommand(Command *f)
620 Modules->AddService(*f);
623 /** Send a modechange.
624 * The parameters provided are identical to that sent to the
625 * handler for class cmd_mode.
626 * @param parameters The mode parameters
627 * @param user The user to send error messages to
629 void SendMode(const std::vector<std::string>& parameters, User *user);
631 /** Send a modechange and route it to the network.
632 * The parameters provided are identical to that sent to the
633 * handler for class cmd_mode.
634 * @param parameters The mode parameters
635 * @param user The user to send error messages to
637 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
639 /** Match two strings using pattern matching, optionally, with a map
640 * to check case against (may be NULL). If map is null, match will be case insensitive.
641 * @param str The literal string to match against
642 * @param mask The glob pattern to match against.
644 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
645 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
647 /** Match two strings using pattern matching, optionally, with a map
648 * to check case against (may be NULL). If map is null, match will be case insensitive.
649 * Supports CIDR patterns as well as globs.
650 * @param str The literal string to match against
651 * @param mask The glob or CIDR pattern to match against.
653 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
654 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
656 /** Call the handler for a given command.
657 * @param commandname The command whos handler you wish to call
658 * @param parameters The mode parameters
659 * @param pcnt The number of items you have given in the first parameter
660 * @param user The user to execute the command as
661 * @return True if the command handler was called successfully
663 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
665 /** Return true if the command is a module-implemented command and the given parameters are valid for it
666 * @param parameters The mode parameters
667 * @param pcnt The number of items you have given in the first parameter
668 * @param user The user to test-execute the command as
669 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
671 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
673 /** Return true if the given parameter is a valid nick!user\@host mask
674 * @param mask A nick!user\@host masak to match against
675 * @return True i the mask is valid
677 bool IsValidMask(const std::string &mask);
679 /** Rehash the local server
683 /** Check if the given nickmask matches too many users, send errors to the given user
684 * @param nick A nickmask to match against
685 * @param user A user to send error text to
686 * @return True if the nick matches too many users
688 bool NickMatchesEveryone(const std::string &nick, User* user);
690 /** Check if the given IP mask matches too many users, send errors to the given user
691 * @param ip An ipmask to match against
692 * @param user A user to send error text to
693 * @return True if the ip matches too many users
695 bool IPMatchesEveryone(const std::string &ip, User* user);
697 /** Check if the given hostmask matches too many users, send errors to the given user
698 * @param mask A hostmask to match against
699 * @param user A user to send error text to
700 * @return True if the host matches too many users
702 bool HostMatchesEveryone(const std::string &mask, User* user);
704 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
705 * @param str A string containing a time in the form 1y2w3d4h6m5s
706 * (one year, two weeks, three days, four hours, six minutes and five seconds)
707 * @return The total number of seconds
709 long Duration(const std::string &str);
711 /** Attempt to compare a password to a string from the config file.
712 * This will be passed to handling modules which will compare the data
713 * against possible hashed equivalents in the input string.
714 * @param ex The object (user, server, whatever) causing the comparison.
715 * @param data The data from the config file
716 * @param input The data input by the oper
717 * @param hashtype The hash from the config file
718 * @return 0 if the strings match, 1 or -1 if they do not
720 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
722 /** Check if a given server is a uline.
723 * An empty string returns true, this is by design.
724 * @param server The server to check for uline status
725 * @return True if the server is a uline OR the string is empty
727 bool ULine(const std::string& server);
729 /** Returns true if the uline is 'silent' (doesnt generate
730 * remote connect notices etc).
732 bool SilentULine(const std::string& server);
734 /** Returns the full version string of this ircd
735 * @return The version string
737 std::string GetVersionString();
739 /** Attempt to write the process id to a given file
740 * @param filename The PID file to attempt to write to
741 * @return This function may bail if the file cannot be written
743 void WritePID(const std::string &filename);
745 /** This constructor initialises all the subsystems and reads the config file.
746 * @param argc The argument count passed to main()
747 * @param argv The argument list passed to main()
748 * @throw <anything> If anything is thrown from here and makes it to
749 * you, you should probably just give up and go home. Yes, really.
750 * It's that bad. Higher level classes should catch any non-fatal exceptions.
752 InspIRCd(int argc, char** argv);
754 /** Send a line of WHOIS data to a user.
755 * @param user user to send the line to
756 * @param dest user being WHOISed
757 * @param numeric Numeric to send
758 * @param text Text of the numeric
760 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
762 /** Send a line of WHOIS data to a user.
763 * @param user user to send the line to
764 * @param dest user being WHOISed
765 * @param numeric Numeric to send
766 * @param format Format string for the numeric
767 * @param ... Parameters for the format string
769 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
773 void DoStats(char statschar, User* user, string_list &results);
777 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
779 /** Quit a user for excess flood, and if they are not
780 * fully registered yet, temporarily zline their IP.
781 * @param current user to quit
783 caller1<void, User*> FloodQuitUser;
785 /** Restart the server.
786 * This function will not return. If an error occurs,
787 * it will throw an instance of CoreException.
788 * @param reason The restart reason to show to all clients
789 * @throw CoreException An instance of CoreException indicating the error from execv().
791 void Restart(const std::string &reason);
793 /** Prepare the ircd for restart or shutdown.
794 * This function unloads all modules which can be unloaded,
795 * closes all open sockets, and closes the logfile.
799 /** This copies the user and channel hash_maps into new hash maps.
800 * This frees memory used by the hash_map allocator (which it neglects
801 * to free, most of the time, using tons of ram)
803 void RehashUsersAndChans();
805 /** Resets the cached max bans value on all channels.
810 /** Return a time_t as a human-readable string.
812 std::string TimeString(time_t curtime);
814 /** Begin execution of the server.
815 * NOTE: this function NEVER returns. Internally,
816 * it will repeatedly loop.
817 * @return The return value for this function is undefined.
821 /** Adds an extban char to the 005 token.
823 void AddExtBanChar(char c);
825 char* GetReadBuffer()
827 return this->ReadBuffer;
834 class CommandModule : public Module
838 CommandModule() : cmd(this)
844 ServerInstance->Modules->AddService(cmd);
849 return Version(cmd.name, VF_VENDOR|VF_CORE);