2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
7 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
9 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 * Copyright (C) 2003 randomdan <???@???>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #define _FILE_OFFSET_BITS 64
30 #ifndef _LARGEFILE_SOURCE
31 #define _LARGEFILE_SOURCE
38 #include "inspircd_win32wrapper.h"
39 /** Windows defines these already */
44 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
46 #define CUSTOM_PRINTF(STRING, FIRST)
49 // Required system headers.
70 #include "inspircd_config.h"
71 #include "inspircd_version.h"
73 #include "consolecolors.h"
75 CoreExport extern InspIRCd* ServerInstance;
78 #include "cull_list.h"
79 #include "extensible.h"
87 #include "usermanager.h"
90 #include "command_parse.h"
92 #include "socketengine.h"
94 #include "filelogger.h"
96 #include "threadengine.h"
97 #include "configreader.h"
98 #include "inspstring.h"
102 #warning Potentially broken system, PATH_MAX undefined
103 #define PATH_MAX 4096
107 * Used to define the maximum number of parameters a command may have.
109 #define MAXPARAMETERS 127
111 /** Returned by some functions to indicate failure.
115 /** Template function to convert any input type to std::string
117 template<typename T> inline std::string ConvNumeric(const T &in)
119 if (in == 0) return "0";
124 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
131 std::reverse(res,out);
135 /** Template function to convert any input type to std::string
137 inline std::string ConvToStr(const int in)
139 return ConvNumeric(in);
142 /** Template function to convert any input type to std::string
144 inline std::string ConvToStr(const long in)
146 return ConvNumeric(in);
149 /** Template function to convert any input type to std::string
151 inline std::string ConvToStr(const char* in)
156 /** Template function to convert any input type to std::string
158 inline std::string ConvToStr(const bool in)
160 return (in ? "1" : "0");
163 /** Template function to convert any input type to std::string
165 inline std::string ConvToStr(char in)
167 return std::string(in,1);
170 /** Template function to convert any input type to std::string
172 template <class T> inline std::string ConvToStr(const T &in)
174 std::stringstream tmp;
175 if (!(tmp << in)) return std::string();
179 /** Template function to convert any input type to any other type
180 * (usually an integer or numeric type)
182 template<typename T> inline long ConvToInt(const T &in)
184 std::stringstream tmp;
185 if (!(tmp << in)) return 0;
186 return atol(tmp.str().c_str());
189 /** This class contains various STATS counters
190 * It is used by the InspIRCd class, which internally
191 * has an instance of it.
196 /** Number of accepted connections
198 unsigned long statsAccept;
199 /** Number of failed accepts
201 unsigned long statsRefused;
202 /** Number of unknown commands seen
204 unsigned long statsUnknown;
205 /** Number of nickname collisions handled
207 unsigned long statsCollisions;
208 /** Number of DNS queries sent out
210 unsigned long statsDns;
211 /** Number of good 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 statsDnsGood;
216 /** Number of bad (negative) DNS replies received
217 * NOTE: This may not tally to the number sent out,
218 * due to timeouts and other latency issues.
220 unsigned long statsDnsBad;
221 /** Number of inbound connections seen
223 unsigned long statsConnects;
224 /** Total bytes of data transmitted
226 unsigned long statsSent;
227 /** Total bytes of data received
229 unsigned long statsRecv;
231 /** Cpu usage at last sample
234 /** Time QP sample was read
236 LARGE_INTEGER LastSampled;
239 LARGE_INTEGER QPFrequency;
241 /** Cpu usage at last sample
244 /** Time last sample was read
246 timespec LastSampled;
248 /** The constructor initializes all the counts to zero
251 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
252 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
257 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
258 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
259 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
260 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
261 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
262 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
263 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
264 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
268 /** The main class of the irc server.
269 * This class contains instances of all the other classes in this software.
270 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
271 * object, and a list of active Module objects, and facilities for Module
272 * objects to interact with the core system it implements.
274 class CoreExport InspIRCd
277 /** Holds the current UID. Used to generate the next one.
279 char current_uid[UUID_LENGTH];
281 /** Set up the signal handlers
285 /** Daemonize the ircd and close standard input/output streams
286 * @return True if the program daemonized succesfully
290 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
291 * @param TIME the current time
293 void DoSocketTimeouts(time_t TIME);
295 /** Increments the current UID by one.
297 void IncrementUID(int pos);
299 /** Perform background user events such as PING checks
301 void DoBackgroundUserStuff();
303 /** Returns true when all modules have done pre-registration checks on a user
304 * @param user The user to verify
305 * @return True if all modules have finished checking this user
307 bool AllModulesReportReady(LocalUser* user);
309 /** The current time, updated in the mainloop
311 struct timespec TIME;
313 /** A 64k buffer used to read socket data into
314 * NOTE: update ValidateNetBufferSize if you change this
316 char ReadBuffer[65535];
320 /** Global cull list, will be processed on next iteration
322 CullList GlobalCulls;
323 /** Actions that must happen outside of the current call stack */
324 ActionList AtomicActions;
328 IsNickHandler HandleIsNick;
329 IsIdentHandler HandleIsIdent;
330 FloodQuitUserHandler HandleFloodQuitUser;
331 OnCheckExemptionHandler HandleOnCheckExemption;
332 IsChannelHandler HandleIsChannel;
333 IsSIDHandler HandleIsSID;
334 RehashHandler HandleRehash;
335 GenRandomHandler HandleGenRandom;
337 /** 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
340 * SendMode expects a User* to send the numeric replies
341 * back to, so we create it a fake user that isnt in the user
342 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
343 * falls into the abyss :p
345 FakeUser* FakeClient;
347 /** Returns the next available UID for this server.
349 std::string GetUID();
351 static const char LogHeader[];
353 /** Find a user in the UUID hash
354 * @param uid The UUID to find
355 * @return A pointer to the user, or NULL if the user does not exist
357 User* FindUUID(const std::string &uid);
359 /** Find a user in the UUID hash
360 * @param uid The UUID to find
361 * @return A pointer to the user, or NULL if the user does not exist
363 User* FindUUID(const char *uid);
365 /** Build the ISUPPORT string by triggering all modules On005Numeric events
367 void BuildISupport();
369 /** Time this ircd was booted
373 /** Config file pathname specified on the commandline or via ./configure
375 std::string ConfigFileName;
377 ExtensionManager Extensions;
379 /** Mode handler, handles mode setting and removal
383 /** Command parser, handles client to server commands
385 CommandParser* Parser;
387 /** Socket engine, handles socket activity events
391 /** Thread engine, Handles threading where required
393 ThreadEngine* Threads;
395 /** The thread/class used to read config files in REHASH and on startup
397 ConfigReaderThread* ConfigThread;
399 /** LogManager handles logging.
403 /** ModuleManager contains everything related to loading/unloading
406 ModuleManager* Modules;
408 /** BanCacheManager is used to speed up checking of restrictions on connection
411 BanCacheManager *BanCache;
413 /** Stats class, holds miscellaneous stats counters
417 /** Server Config class, holds configuration file data
419 ServerConfig* Config;
421 /** Snomask manager - handles routing of snomask messages
426 /** DNS class, provides resolver facilities to the core and modules
430 /** Timer manager class, triggers Timer timer events
432 TimerManager* Timers;
434 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
436 XLineManager* XLines;
438 /** User manager. Various methods and data associated with users.
442 /** Channel list, a hash_map containing all channels XXX move to channel manager class
446 /** List of the open ports
448 std::vector<ListenSocket*> ports;
450 /** Set to the current signal recieved
454 /** Protocol interface, overridden by server protocol modules
456 ProtocolInterface* PI;
458 /** Holds extensible for user nickforced
460 LocalIntExt NICKForced;
462 /** Holds extensible for user operquit
464 LocalStringExt OperQuit;
466 /** Get the current time
467 * Because this only calls time() once every time around the mainloop,
468 * it is much faster than calling time() directly.
469 * @return The current time as an epoch value (time_t)
471 inline time_t Time() { return TIME.tv_sec; }
472 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
473 inline long Time_ns() { return TIME.tv_nsec; }
474 /** Update the current time. Don't call this unless you have reason to do so. */
477 /** Generate a random string with the given length
478 * @param length The length in bytes
479 * @param printable if false, the string will use characters 0-255; otherwise,
480 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
482 std::string GenRandomStr(int length, bool printable = true);
483 /** Generate a random integer.
484 * This is generally more secure than rand()
486 unsigned long GenRandomInt(unsigned long max);
488 /** Fill a buffer with random bits */
489 caller2<void, char*, size_t> GenRandom;
491 /** Bind all ports specified in the configuration file.
492 * @return The number of ports bound without error
494 int BindPorts(FailedPortList &failed_ports);
496 /** Binds a socket on an already open file descriptor
497 * @param sockfd A valid file descriptor of an open socket
498 * @param port The port number to bind to
499 * @param addr The address to bind to (IP only)
500 * @param dolisten Should this port be listened on?
501 * @return True if the port was bound successfully
503 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
505 /** Gets the GECOS (description) field of the given server.
506 * If the servername is not that of the local server, the name
507 * is passed to handling modules which will attempt to determine
508 * the GECOS that bleongs to the given servername.
509 * @param servername The servername to find the description of
510 * @return The description of this server, or of the local server
512 std::string GetServerDescription(const std::string& servername);
514 /** Find a user in the nick hash.
515 * If the user cant be found in the nick hash check the uuid hash
516 * @param nick The nickname to find
517 * @return A pointer to the user, or NULL if the user does not exist
519 User* FindNick(const std::string &nick);
521 /** Find a user in the nick hash.
522 * If the user cant be found in the nick hash check the uuid hash
523 * @param nick The nickname to find
524 * @return A pointer to the user, or NULL if the user does not exist
526 User* FindNick(const char* nick);
528 /** Find a user in the nick hash ONLY
530 User* FindNickOnly(const char* nick);
532 /** Find a user in the nick hash ONLY
534 User* FindNickOnly(const std::string &nick);
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 std::string &chan);
542 /** Find a channel in the channels hash
543 * @param chan The channel to find
544 * @return A pointer to the channel, or NULL if the channel does not exist
546 Channel* FindChan(const char* chan);
548 /** Check we aren't running as root, and exit if we are
549 * @return Depending on the configuration, this function may never return
553 /** Determine the right path for, and open, the logfile
554 * @param argv The argv passed to main() initially, used to calculate program path
555 * @param argc The argc passed to main() initially, used to calculate program path
556 * @return True if the log could be opened, false if otherwise
558 bool OpenLog(char** argv, int argc);
560 /** Return true if a channel name is valid
561 * @param chname A channel name to verify
562 * @return True if the name is valid
564 caller2<bool, const char*, size_t> IsChannel;
566 /** Return true if str looks like a server ID
567 * @param string to check against
569 caller1<bool, const std::string&> IsSID;
571 /** Rehash the local server
573 caller1<void, const std::string&> Rehash;
575 /** Handles incoming signals after being set
576 * @param signal the signal recieved
578 void SignalHandler(int signal);
580 /** Sets the signal recieved
581 * @param signal the signal recieved
583 static void SetSignal(int signal);
585 /** Causes the server to exit after unloading modules and
586 * closing all open file descriptors.
588 * @param status The exit code to give to the operating system
589 * (See the ExitStatus enum for valid values)
591 void Exit(int status);
593 /** Causes the server to exit immediately with exit code 0.
594 * The status code is required for signal handlers, and ignored.
596 static void QuickExit(int status);
598 /** Return a count of channels on the network
599 * @return The number of channels
603 /** Send an error notice to all local users, opered and unopered
604 * @param s The error string to send
606 void SendError(const std::string &s);
608 /** Return true if a nickname is valid
609 * @param n A nickname to verify
610 * @return True if the nick is valid
612 caller2<bool, const char*, size_t> IsNick;
614 /** Return true if an ident is valid
615 * @param An ident to verify
616 * @return True if the ident is valid
618 caller1<bool, const char*> IsIdent;
620 /** Add a dns Resolver class to this server's active set
621 * @param r The resolver to add
622 * @param cached If this value is true, then the cache will
623 * be searched for the DNS result, immediately. If the value is
624 * false, then a request will be sent to the nameserver, and the
625 * result will not be immediately available. You should usually
626 * use the boolean value which you passed to the Resolver
627 * constructor, which Resolver will set appropriately depending
628 * on if cached results are available and haven't expired. It is
629 * however safe to force this value to false, forcing a remote DNS
630 * lookup, but not an update of the cache.
631 * @return True if the operation completed successfully. Note that
632 * if this method returns true, you should not attempt to access
633 * the resolver class you pass it after this call, as depending upon
634 * the request given, the object may be deleted!
636 bool AddResolver(Resolver* r, bool cached);
638 /** Add a command to this server's command parser
639 * @param f A Command command handler object to add
640 * @throw ModuleException Will throw ModuleExcption if the command already exists
642 inline void AddCommand(Command *f)
644 Modules->AddService(*f);
647 /** Send a modechange.
648 * The parameters provided are identical to that sent to the
649 * handler for class cmd_mode.
650 * @param parameters The mode parameters
651 * @param user The user to send error messages to
653 void SendMode(const std::vector<std::string>& parameters, User *user);
655 /** Send a modechange and route it to the network.
656 * The parameters provided are identical to that sent to the
657 * handler for class cmd_mode.
658 * @param parameters The mode parameters
659 * @param user The user to send error messages to
661 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
663 /** Match two strings using pattern matching, optionally, with a map
664 * to check case against (may be NULL). If map is null, match will be case insensitive.
665 * @param str The literal string to match against
666 * @param mask The glob pattern to match against.
667 * @param map The character map to use when matching.
669 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
670 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
672 /** Match two strings using pattern matching, optionally, with a map
673 * to check case against (may be NULL). If map is null, match will be case insensitive.
674 * Supports CIDR patterns as well as globs.
675 * @param str The literal string to match against
676 * @param mask The glob or CIDR pattern to match against.
677 * @param map The character map to use when matching.
679 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
680 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
682 /** Call the handler for a given command.
683 * @param commandname The command whos handler you wish to call
684 * @param parameters The mode parameters
685 * @param user The user to execute the command as
686 * @return True if the command handler was called successfully
688 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
690 /** Return true if the command is a module-implemented command and the given parameters are valid for it
691 * @param commandname The command name to check
692 * @param pcnt The parameter count
693 * @param user The user to test-execute the command as
694 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
696 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
698 /** Return true if the given parameter is a valid nick!user\@host mask
699 * @param mask A nick!user\@host masak to match against
700 * @return True i the mask is valid
702 bool IsValidMask(const std::string &mask);
704 /** Strips all color codes from the given string
705 * @param sentence The string to strip from
707 static void StripColor(std::string &sentence);
709 /** Parses color codes from string values to actual color codes
710 * @param input The data to process
712 static void ProcessColors(file_cache& input);
714 /** Rehash the local server
718 /** Check if the given nickmask matches too many users, send errors to the given user
719 * @param nick A nickmask to match against
720 * @param user A user to send error text to
721 * @return True if the nick matches too many users
723 bool NickMatchesEveryone(const std::string &nick, User* user);
725 /** Check if the given IP mask matches too many users, send errors to the given user
726 * @param ip An ipmask to match against
727 * @param user A user to send error text to
728 * @return True if the ip matches too many users
730 bool IPMatchesEveryone(const std::string &ip, User* user);
732 /** Check if the given hostmask matches too many users, send errors to the given user
733 * @param mask A hostmask to match against
734 * @param user A user to send error text to
735 * @return True if the host matches too many users
737 bool HostMatchesEveryone(const std::string &mask, User* user);
739 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
740 * @param str A string containing a time in the form 1y2w3d4h6m5s
741 * (one year, two weeks, three days, four hours, six minutes and five seconds)
742 * @return The total number of seconds
744 long Duration(const std::string &str);
746 /** Attempt to compare a password to a string from the config file.
747 * This will be passed to handling modules which will compare the data
748 * against possible hashed equivalents in the input string.
749 * @param ex The object (user, server, whatever) causing the comparison.
750 * @param data The data from the config file
751 * @param input The data input by the oper
752 * @param hashtype The hash from the config file
753 * @return 0 if the strings match, 1 or -1 if they do not
755 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
757 /** Check if a given server is a uline.
758 * An empty string returns true, this is by design.
759 * @param server The server to check for uline status
760 * @return True if the server is a uline OR the string is empty
762 bool ULine(const std::string& server);
764 /** Returns true if the uline is 'silent' (doesnt generate
765 * remote connect notices etc).
767 bool SilentULine(const std::string& server);
769 /** Returns the full version string of this ircd
770 * @return The version string
772 std::string GetVersionString(bool rawversion = false);
774 /** Attempt to write the process id to a given file
775 * @param filename The PID file to attempt to write to
776 * @return This function may bail if the file cannot be written
778 void WritePID(const std::string &filename);
780 /** This constructor initialises all the subsystems and reads the config file.
781 * @param argc The argument count passed to main()
782 * @param argv The argument list passed to main()
783 * @throw <anything> If anything is thrown from here and makes it to
784 * you, you should probably just give up and go home. Yes, really.
785 * It's that bad. Higher level classes should catch any non-fatal exceptions.
787 InspIRCd(int argc, char** argv);
789 /** Send a line of WHOIS data to a user.
790 * @param user user to send the line to
791 * @param dest user being WHOISed
792 * @param numeric Numeric to send
793 * @param text Text of the numeric
795 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
797 /** Send a line of WHOIS data to a user.
798 * @param user user to send the line to
799 * @param dest user being WHOISed
800 * @param numeric Numeric to send
801 * @param format Format string for the numeric
802 * @param ... Parameters for the format string
804 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
808 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
810 /** Quit a user for excess flood, and if they are not
811 * fully registered yet, temporarily zline their IP.
812 * @param current user to quit
814 caller1<void, User*> FloodQuitUser;
816 /** Called to check whether a channel restriction mode applies to a user
817 * @param User that is attempting some action
818 * @param Channel that the action is being performed on
821 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
823 /** Restart the server.
824 * This function will not return. If an error occurs,
825 * it will throw an instance of CoreException.
826 * @param reason The restart reason to show to all clients
827 * @throw CoreException An instance of CoreException indicating the error from execv().
829 void Restart(const std::string &reason);
831 /** Prepare the ircd for restart or shutdown.
832 * This function unloads all modules which can be unloaded,
833 * closes all open sockets, and closes the logfile.
837 /** This copies the user and channel hash_maps into new hash maps.
838 * This frees memory used by the hash_map allocator (which it neglects
839 * to free, most of the time, using tons of ram)
841 void RehashUsersAndChans();
843 /** Resets the cached max bans value on all channels.
848 /** Return a time_t as a human-readable string.
850 std::string TimeString(time_t curtime);
852 /** Begin execution of the server.
853 * NOTE: this function NEVER returns. Internally,
854 * it will repeatedly loop.
855 * @return The return value for this function is undefined.
859 /** Adds an extban char to the 005 token.
861 void AddExtBanChar(char c);
863 char* GetReadBuffer()
865 return this->ReadBuffer;
868 friend class TestSuite;
874 class CommandModule : public Module
878 CommandModule() : cmd(this)
884 ServerInstance->Modules->AddService(cmd);
889 return Version(cmd.name, VF_VENDOR|VF_CORE);