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"
92 #warning Potentially broken system, PATH_MAX undefined
97 * Used to define the maximum number of parameters a command may have.
99 #define MAXPARAMETERS 127
101 /** Returned by some functions to indicate failure.
105 /** Support for librodent -
106 * see http://www.chatspike.net/index.php?z=64
108 #define ETIREDHAMSTERS EAGAIN
110 /** Template function to convert any input type to std::string
112 template<typename T> inline std::string ConvNumeric(const T &in)
114 if (in == 0) return "0";
119 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
126 std::reverse(res,out);
130 /** Template function to convert any input type to std::string
132 inline std::string ConvToStr(const int in)
134 return ConvNumeric(in);
137 /** Template function to convert any input type to std::string
139 inline std::string ConvToStr(const long in)
141 return ConvNumeric(in);
144 /** Template function to convert any input type to std::string
146 inline std::string ConvToStr(const char* in)
151 /** Template function to convert any input type to std::string
153 inline std::string ConvToStr(const bool in)
155 return (in ? "1" : "0");
158 /** Template function to convert any input type to std::string
160 inline std::string ConvToStr(char in)
162 return std::string(in,1);
165 /** Template function to convert any input type to std::string
167 template <class T> inline std::string ConvToStr(const T &in)
169 std::stringstream tmp;
170 if (!(tmp << in)) return std::string();
174 /** Template function to convert any input type to any other type
175 * (usually an integer or numeric type)
177 template<typename T> inline long ConvToInt(const T &in)
179 std::stringstream tmp;
180 if (!(tmp << in)) return 0;
181 return atol(tmp.str().c_str());
184 /** This class contains various STATS counters
185 * It is used by the InspIRCd class, which internally
186 * has an instance of it.
191 /** Number of accepted connections
193 unsigned long statsAccept;
194 /** Number of failed accepts
196 unsigned long statsRefused;
197 /** Number of unknown commands seen
199 unsigned long statsUnknown;
200 /** Number of nickname collisions handled
202 unsigned long statsCollisions;
203 /** Number of DNS queries sent out
205 unsigned long statsDns;
206 /** Number of good DNS replies received
207 * NOTE: This may not tally to the number sent out,
208 * due to timeouts and other latency issues.
210 unsigned long statsDnsGood;
211 /** Number of bad (negative) DNS replies received
212 * NOTE: This may not tally to the number sent out,
213 * due to timeouts and other latency issues.
215 unsigned long statsDnsBad;
216 /** Number of inbound connections seen
218 unsigned long statsConnects;
219 /** Total bytes of data transmitted
222 /** Total bytes of data received
225 /** Cpu usage at last sample
228 /** Time last sample was read
231 /** The constructor initializes all the counts to zero
234 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
235 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
242 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
243 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
244 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
245 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
246 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
247 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
249 /* Forward declaration - required */
251 class BanCacheManager;
253 /** The background thread for config reading, so that reading from executable includes
256 class CoreExport ConfigReaderThread : public Thread
258 ServerConfig* Config;
261 std::string TheUserUID;
262 ConfigReaderThread(const std::string &useruid)
263 : Thread(), done(false), TheUserUID(useruid)
267 virtual ~ConfigReaderThread()
272 /** Run in the main thread to apply the configuration */
274 bool IsDone() { return done; }
277 /** The main class of the irc server.
278 * This class contains instances of all the other classes in this software.
279 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
280 * object, and a list of active Module objects, and facilities for Module
281 * objects to interact with the core system it implements.
283 class CoreExport InspIRCd
286 /** Holds the current UID. Used to generate the next one.
288 char current_uid[UUID_LENGTH];
290 /** Set up the signal handlers
294 /** Daemonize the ircd and close standard input/output streams
295 * @return True if the program daemonized succesfully
299 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
300 * @param TIME the current time
302 void DoSocketTimeouts(time_t TIME);
304 /** Increments the current UID by one.
306 void IncrementUID(int pos);
308 /** Perform background user events such as PING checks
310 void DoBackgroundUserStuff();
312 /** Returns true when all modules have done pre-registration checks on a user
313 * @param user The user to verify
314 * @return True if all modules have finished checking this user
316 bool AllModulesReportReady(LocalUser* user);
318 /** The current time, updated in the mainloop
322 /** The time that was recorded last time around the mainloop
326 /** A 64k buffer used to read socket data into
327 * NOTE: update ValidateNetBufferSize if you change this
329 char ReadBuffer[65535];
337 /** Global cull list, will be processed on next iteration
339 CullList GlobalCulls;
340 /** Actions that must happen outside of the current call stack */
341 ActionList AtomicActions;
345 IsNickHandler HandleIsNick;
346 IsIdentHandler HandleIsIdent;
347 FloodQuitUserHandler HandleFloodQuitUser;
348 IsChannelHandler HandleIsChannel;
349 IsSIDHandler HandleIsSID;
350 RehashHandler HandleRehash;
352 /** 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
355 * SendMode expects a User* to send the numeric replies
356 * back to, so we create it a fake user that isnt in the user
357 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
358 * falls into the abyss :p
360 FakeUser* FakeClient;
362 /** Returns the next available UID for this server.
364 std::string GetUID();
366 /** Find a user in the UUID hash
367 * @param nick The nickname to find
368 * @return A pointer to the user, or NULL if the user does not exist
370 User* FindUUID(const std::string &);
372 /** Find a user in the UUID hash
373 * @param nick The nickname to find
374 * @return A pointer to the user, or NULL if the user does not exist
376 User* FindUUID(const char *);
378 /** Build the ISUPPORT string by triggering all modules On005Numeric events
380 void BuildISupport();
382 /** Time this ircd was booted
386 /** Config file pathname specified on the commandline or via ./configure
388 std::string ConfigFileName;
390 ExtensionManager Extensions;
392 /** Mode handler, handles mode setting and removal
396 /** Command parser, handles client to server commands
398 CommandParser* Parser;
400 /** Socket engine, handles socket activity events
404 /** Thread engine, Handles threading where required
406 ThreadEngine* Threads;
408 /** The thread/class used to read config files in REHASH and on startup
410 ConfigReaderThread* ConfigThread;
412 /** LogManager handles logging.
416 /** ModuleManager contains everything related to loading/unloading
419 ModuleManager* Modules;
421 /** BanCacheManager is used to speed up checking of restrictions on connection
424 BanCacheManager *BanCache;
426 /** Stats class, holds miscellaneous stats counters
430 /** Server Config class, holds configuration file data
432 ServerConfig* Config;
434 /** Snomask manager - handles routing of snomask messages
439 /** DNS class, provides resolver facilities to the core and modules
443 /** Timer manager class, triggers Timer timer events
445 TimerManager* Timers;
447 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
449 XLineManager* XLines;
451 /** User manager. Various methods and data associated with users.
455 /** Channel list, a hash_map containing all channels XXX move to channel manager class
459 /** List of the open ports
461 std::vector<ListenSocket*> ports;
463 /** Set to the current signal recieved
467 /** Protocol interface, overridden by server protocol modules
469 ProtocolInterface* PI;
471 /** Holds extensible for user nickforced
473 LocalIntExt NICKForced;
475 /** Holds extensible for user operquit
477 LocalStringExt OperQuit;
479 /** Get the current time
480 * Because this only calls time() once every time around the mainloop,
481 * it is much faster than calling time() directly.
482 * @return The current time as an epoch value (time_t)
486 /** Bind all ports specified in the configuration file.
487 * @return The number of ports bound without error
489 int BindPorts(FailedPortList &failed_ports);
491 /** Binds a socket on an already open file descriptor
492 * @param sockfd A valid file descriptor of an open socket
493 * @param port The port number to bind to
494 * @param addr The address to bind to (IP only)
495 * @return True if the port was bound successfully
497 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
499 /** Gets the GECOS (description) field of the given server.
500 * If the servername is not that of the local server, the name
501 * is passed to handling modules which will attempt to determine
502 * the GECOS that bleongs to the given servername.
503 * @param servername The servername to find the description of
504 * @return The description of this server, or of the local server
506 std::string GetServerDescription(const std::string& servername);
508 /** Find a user in the nick hash.
509 * If the user cant be found in the nick hash check the uuid hash
510 * @param nick The nickname to find
511 * @return A pointer to the user, or NULL if the user does not exist
513 User* FindNick(const std::string &nick);
515 /** Find a user in the nick hash.
516 * If the user cant be found in the nick hash check the uuid hash
517 * @param nick The nickname to find
518 * @return A pointer to the user, or NULL if the user does not exist
520 User* FindNick(const char* nick);
522 /** Find a user in the nick hash ONLY
524 User* FindNickOnly(const char* nick);
526 /** Find a user in the nick hash ONLY
528 User* FindNickOnly(const std::string &nick);
530 /** Find a channel in the channels hash
531 * @param chan The channel to find
532 * @return A pointer to the channel, or NULL if the channel does not exist
534 Channel* FindChan(const std::string &chan);
536 /** Find a channel in the channels hash
537 * @param chan The channel to find
538 * @return A pointer to the channel, or NULL if the channel does not exist
540 Channel* FindChan(const char* chan);
542 /** Check we aren't running as root, and exit if we are
543 * @return Depending on the configuration, this function may never return
547 /** Determine the right path for, and open, the logfile
548 * @param argv The argv passed to main() initially, used to calculate program path
549 * @param argc The argc passed to main() initially, used to calculate program path
550 * @return True if the log could be opened, false if otherwise
552 bool OpenLog(char** argv, int argc);
554 /** Return true if a channel name is valid
555 * @param chname A channel name to verify
556 * @return True if the name is valid
558 caller2<bool, const char*, size_t> IsChannel;
560 /** Return true if str looks like a server ID
561 * @param string to check against
563 caller1<bool, const std::string&> IsSID;
565 /** Rehash the local server
567 caller1<void, const std::string&> Rehash;
569 /** Handles incoming signals after being set
570 * @param signal the signal recieved
572 void SignalHandler(int signal);
574 /** Sets the signal recieved
575 * @param signal the signal recieved
577 static void SetSignal(int signal);
579 /** Causes the server to exit after unloading modules and
580 * closing all open file descriptors.
582 * @param The exit code to give to the operating system
583 * (See the ExitStatus enum for valid values)
585 void Exit(int status);
587 /** Causes the server to exit immediately with exit code 0.
588 * The status code is required for signal handlers, and ignored.
590 static void QuickExit(int status);
592 /** Return a count of channels on the network
593 * @return The number of channels
597 /** Send an error notice to all local users, opered and unopered
598 * @param s The error string to send
600 void SendError(const std::string &s);
602 /** Return true if a nickname is valid
603 * @param n A nickname to verify
604 * @return True if the nick is valid
606 caller2<bool, const char*, size_t> IsNick;
608 /** Return true if an ident is valid
609 * @param An ident to verify
610 * @return True if the ident is valid
612 caller1<bool, const char*> IsIdent;
614 /** Add a dns Resolver class to this server's active set
615 * @param r The resolver to add
616 * @param cached If this value is true, then the cache will
617 * be searched for the DNS result, immediately. If the value is
618 * false, then a request will be sent to the nameserver, and the
619 * result will not be immediately available. You should usually
620 * use the boolean value which you passed to the Resolver
621 * constructor, which Resolver will set appropriately depending
622 * on if cached results are available and haven't expired. It is
623 * however safe to force this value to false, forcing a remote DNS
624 * lookup, but not an update of the cache.
625 * @return True if the operation completed successfully. Note that
626 * if this method returns true, you should not attempt to access
627 * the resolver class you pass it after this call, as depending upon
628 * the request given, the object may be deleted!
630 bool AddResolver(Resolver* r, bool cached);
632 /** Add a command to this server's command parser
633 * @param f A Command command handler object to add
634 * @throw ModuleException Will throw ModuleExcption if the command already exists
636 void AddCommand(Command *f);
638 /** Send a modechange.
639 * The parameters provided are identical to that sent to the
640 * handler for class cmd_mode.
641 * @param parameters The mode parameters
642 * @param user The user to send error messages to
644 void SendMode(const std::vector<std::string>& parameters, User *user);
646 /** Match two strings using pattern matching, optionally, with a map
647 * to check case against (may be NULL). If map is null, match will be case insensitive.
648 * @param str The literal string to match against
649 * @param mask The glob pattern to match against.
651 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
652 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
654 /** Match two strings using pattern matching, optionally, with a map
655 * to check case against (may be NULL). If map is null, match will be case insensitive.
656 * Supports CIDR patterns as well as globs.
657 * @param str The literal string to match against
658 * @param mask The glob or CIDR pattern to match against.
660 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
661 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
663 /** Call the handler for a given command.
664 * @param commandname The command whos handler you wish to call
665 * @param parameters The mode parameters
666 * @param pcnt The number of items you have given in the first parameter
667 * @param user The user to execute the command as
668 * @return True if the command handler was called successfully
670 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
672 /** Return true if the command is a module-implemented command and the given parameters are valid for it
673 * @param parameters The mode parameters
674 * @param pcnt The number of items you have given in the first parameter
675 * @param user The user to test-execute the command as
676 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
678 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
680 /** Return true if the given parameter is a valid nick!user\@host mask
681 * @param mask A nick!user\@host masak to match against
682 * @return True i the mask is valid
684 bool IsValidMask(const std::string &mask);
686 /** Rehash the local server
690 /** Check if the given nickmask matches too many users, send errors to the given user
691 * @param nick A nickmask to match against
692 * @param user A user to send error text to
693 * @return True if the nick matches too many users
695 bool NickMatchesEveryone(const std::string &nick, User* user);
697 /** Check if the given IP mask matches too many users, send errors to the given user
698 * @param ip An ipmask to match against
699 * @param user A user to send error text to
700 * @return True if the ip matches too many users
702 bool IPMatchesEveryone(const std::string &ip, User* user);
704 /** Check if the given hostmask matches too many users, send errors to the given user
705 * @param mask A hostmask to match against
706 * @param user A user to send error text to
707 * @return True if the host matches too many users
709 bool HostMatchesEveryone(const std::string &mask, User* user);
711 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
712 * @param str A string containing a time in the form 1y2w3d4h6m5s
713 * (one year, two weeks, three days, four hours, six minutes and five seconds)
714 * @return The total number of seconds
716 long Duration(const std::string &str);
718 /** Attempt to compare a password to a string from the config file.
719 * This will be passed to handling modules which will compare the data
720 * against possible hashed equivalents in the input string.
721 * @param ex The object (user, server, whatever) causing the comparison.
722 * @param data The data from the config file
723 * @param input The data input by the oper
724 * @param hashtype The hash from the config file
725 * @return 0 if the strings match, 1 or -1 if they do not
727 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
729 /** Check if a given server is a uline.
730 * An empty string returns true, this is by design.
731 * @param server The server to check for uline status
732 * @return True if the server is a uline OR the string is empty
734 bool ULine(const std::string& server);
736 /** Returns true if the uline is 'silent' (doesnt generate
737 * remote connect notices etc).
739 bool SilentULine(const std::string& server);
741 /** Returns the full version string of this ircd
742 * @return The version string
744 std::string GetVersionString();
746 /** Attempt to write the process id to a given file
747 * @param filename The PID file to attempt to write to
748 * @return This function may bail if the file cannot be written
750 void WritePID(const std::string &filename);
752 /** This constructor initialises all the subsystems and reads the config file.
753 * @param argc The argument count passed to main()
754 * @param argv The argument list passed to main()
755 * @throw <anything> If anything is thrown from here and makes it to
756 * you, you should probably just give up and go home. Yes, really.
757 * It's that bad. Higher level classes should catch any non-fatal exceptions.
759 InspIRCd(int argc, char** argv);
761 /** Send a line of WHOIS data to a user.
762 * @param user user to send the line to
763 * @param dest user being WHOISed
764 * @param numeric Numeric to send
765 * @param text Text of the numeric
767 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
769 /** Send a line of WHOIS data to a user.
770 * @param user user to send the line to
771 * @param dest user being WHOISed
772 * @param numeric Numeric to send
773 * @param format Format string for the numeric
774 * @param ... Parameters for the format string
776 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
780 void DoStats(char statschar, User* user, string_list &results);
784 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
786 /** Quit a user for excess flood, and if they are not
787 * fully registered yet, temporarily zline their IP.
788 * @param current user to quit
790 caller1<void, User*> FloodQuitUser;
792 /** Restart the server.
793 * This function will not return. If an error occurs,
794 * it will throw an instance of CoreException.
795 * @param reason The restart reason to show to all clients
796 * @throw CoreException An instance of CoreException indicating the error from execv().
798 void Restart(const std::string &reason);
800 /** Prepare the ircd for restart or shutdown.
801 * This function unloads all modules which can be unloaded,
802 * closes all open sockets, and closes the logfile.
806 /** This copies the user and channel hash_maps into new hash maps.
807 * This frees memory used by the hash_map allocator (which it neglects
808 * to free, most of the time, using tons of ram)
810 void RehashUsersAndChans();
812 /** Resets the cached max bans value on all channels.
817 /** Return a time_t as a human-readable string.
819 std::string TimeString(time_t curtime);
821 /** Begin execution of the server.
822 * NOTE: this function NEVER returns. Internally,
823 * it will repeatedly loop.
824 * @return The return value for this function is undefined.
828 /** Adds an extban char to the 005 token.
830 void AddExtBanChar(char c);
832 char* GetReadBuffer()
834 return this->ReadBuffer;
841 class CommandModule : public Module
845 CommandModule() : cmd(this)
847 ServerInstance->AddCommand(&cmd);
852 return Version(cmd.command, VF_VENDOR|VF_CORE);