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 #if defined __clang__ || defined __GNUC__
50 # define DEPRECATED_METHOD(function) function __attribute__((deprecated))
51 #elif defined _MSC_VER
52 # define DEPRECATED_METHOD(function) __declspec(deprecated) function
54 # pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
55 # define DEPRECATED_METHOD(function) function
58 // Required system headers.
79 #include "inspircd_config.h"
80 #include "inspircd_version.h"
82 #include "consolecolors.h"
84 CoreExport extern InspIRCd* ServerInstance;
87 #include "cull_list.h"
88 #include "extensible.h"
96 #include "usermanager.h"
99 #include "command_parse.h"
101 #include "socketengine.h"
102 #include "snomasks.h"
103 #include "filelogger.h"
105 #include "threadengine.h"
106 #include "configreader.h"
107 #include "inspstring.h"
108 #include "protocol.h"
111 #warning Potentially broken system, PATH_MAX undefined
112 #define PATH_MAX 4096
116 * Used to define the maximum number of parameters a command may have.
118 #define MAXPARAMETERS 127
120 /** Returned by some functions to indicate failure.
124 /** Template function to convert any input type to std::string
126 template<typename T> inline std::string ConvNumeric(const T &in)
128 if (in == 0) return "0";
133 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
140 std::reverse(res,out);
144 /** Template function to convert any input type to std::string
146 inline std::string ConvToStr(const int in)
148 return ConvNumeric(in);
151 /** Template function to convert any input type to std::string
153 inline std::string ConvToStr(const long in)
155 return ConvNumeric(in);
158 /** Template function to convert any input type to std::string
160 inline std::string ConvToStr(const char* in)
165 /** Template function to convert any input type to std::string
167 inline std::string ConvToStr(const bool in)
169 return (in ? "1" : "0");
172 /** Template function to convert any input type to std::string
174 inline std::string ConvToStr(char in)
176 return std::string(in,1);
179 /** Template function to convert any input type to std::string
181 template <class T> inline std::string ConvToStr(const T &in)
183 std::stringstream tmp;
184 if (!(tmp << in)) return std::string();
188 /** Template function to convert any input type to any other type
189 * (usually an integer or numeric type)
191 template<typename T> inline long ConvToInt(const T &in)
193 std::stringstream tmp;
194 if (!(tmp << in)) return 0;
195 return atol(tmp.str().c_str());
198 /** This class contains various STATS counters
199 * It is used by the InspIRCd class, which internally
200 * has an instance of it.
205 /** Number of accepted connections
207 unsigned long statsAccept;
208 /** Number of failed accepts
210 unsigned long statsRefused;
211 /** Number of unknown commands seen
213 unsigned long statsUnknown;
214 /** Number of nickname collisions handled
216 unsigned long statsCollisions;
217 /** Number of DNS queries sent out
219 unsigned long statsDns;
220 /** Number of good DNS replies received
221 * NOTE: This may not tally to the number sent out,
222 * due to timeouts and other latency issues.
224 unsigned long statsDnsGood;
225 /** Number of bad (negative) DNS replies received
226 * NOTE: This may not tally to the number sent out,
227 * due to timeouts and other latency issues.
229 unsigned long statsDnsBad;
230 /** Number of inbound connections seen
232 unsigned long statsConnects;
233 /** Total bytes of data transmitted
235 unsigned long statsSent;
236 /** Total bytes of data received
238 unsigned long statsRecv;
240 /** Cpu usage at last sample
243 /** Time QP sample was read
245 LARGE_INTEGER LastSampled;
248 LARGE_INTEGER QPFrequency;
250 /** Cpu usage at last sample
253 /** Time last sample was read
255 timespec LastSampled;
257 /** The constructor initializes all the counts to zero
260 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
261 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
266 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
267 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
268 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
269 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
270 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
271 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
272 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
273 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
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
320 struct timespec TIME;
322 /** A 64k buffer used to read socket data into
323 * NOTE: update ValidateNetBufferSize if you change this
325 char ReadBuffer[65535];
329 /** Global cull list, will be processed on next iteration
331 CullList GlobalCulls;
332 /** Actions that must happen outside of the current call stack */
333 ActionList AtomicActions;
337 IsNickHandler HandleIsNick;
338 IsIdentHandler HandleIsIdent;
339 FloodQuitUserHandler HandleFloodQuitUser;
340 OnCheckExemptionHandler HandleOnCheckExemption;
341 IsChannelHandler HandleIsChannel;
342 IsSIDHandler HandleIsSID;
343 RehashHandler HandleRehash;
344 GenRandomHandler HandleGenRandom;
346 /** 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
349 * SendMode expects a User* to send the numeric replies
350 * back to, so we create it a fake user that isnt in the user
351 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
352 * falls into the abyss :p
354 FakeUser* FakeClient;
356 /** Returns the next available UID for this server.
358 std::string GetUID();
360 static const char LogHeader[];
362 /** Find a user in the UUID hash
363 * @param uid The UUID to find
364 * @return A pointer to the user, or NULL if the user does not exist
366 User* FindUUID(const std::string &uid);
368 /** Find a user in the UUID hash
369 * @param uid The UUID to find
370 * @return A pointer to the user, or NULL if the user does not exist
372 User* FindUUID(const char *uid);
374 /** Build the ISUPPORT string by triggering all modules On005Numeric events
376 void BuildISupport();
378 /** Time this ircd was booted
382 /** Config file pathname specified on the commandline or via ./configure
384 std::string ConfigFileName;
386 ExtensionManager Extensions;
388 /** Mode handler, handles mode setting and removal
392 /** Command parser, handles client to server commands
394 CommandParser* Parser;
396 /** Socket engine, handles socket activity events
400 /** Thread engine, Handles threading where required
402 ThreadEngine* Threads;
404 /** The thread/class used to read config files in REHASH and on startup
406 ConfigReaderThread* ConfigThread;
408 /** LogManager handles logging.
412 /** ModuleManager contains everything related to loading/unloading
415 ModuleManager* Modules;
417 /** BanCacheManager is used to speed up checking of restrictions on connection
420 BanCacheManager *BanCache;
422 /** Stats class, holds miscellaneous stats counters
426 /** Server Config class, holds configuration file data
428 ServerConfig* Config;
430 /** Snomask manager - handles routing of snomask messages
435 /** DNS class, provides resolver facilities to the core and modules
439 /** Timer manager class, triggers Timer timer events
441 TimerManager* Timers;
443 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
445 XLineManager* XLines;
447 /** User manager. Various methods and data associated with users.
451 /** Channel list, a hash_map containing all channels XXX move to channel manager class
455 /** List of the open ports
457 std::vector<ListenSocket*> ports;
459 /** Set to the current signal recieved
463 /** Protocol interface, overridden by server protocol modules
465 ProtocolInterface* PI;
467 /** Holds extensible for user nickforced
469 LocalIntExt NICKForced;
471 /** Holds extensible for user operquit
473 LocalStringExt OperQuit;
475 /** Get the current time
476 * Because this only calls time() once every time around the mainloop,
477 * it is much faster than calling time() directly.
478 * @return The current time as an epoch value (time_t)
480 inline time_t Time() { return TIME.tv_sec; }
481 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
482 inline long Time_ns() { return TIME.tv_nsec; }
483 /** Update the current time. Don't call this unless you have reason to do so. */
486 /** Generate a random string with the given length
487 * @param length The length in bytes
488 * @param printable if false, the string will use characters 0-255; otherwise,
489 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
491 std::string GenRandomStr(int length, bool printable = true);
492 /** Generate a random integer.
493 * This is generally more secure than rand()
495 unsigned long GenRandomInt(unsigned long max);
497 /** Fill a buffer with random bits */
498 caller2<void, char*, size_t> GenRandom;
500 /** Bind all ports specified in the configuration file.
501 * @return The number of ports bound without error
503 int BindPorts(FailedPortList &failed_ports);
505 /** Binds a socket on an already open file descriptor
506 * @param sockfd A valid file descriptor of an open socket
507 * @param port The port number to bind to
508 * @param addr The address to bind to (IP only)
509 * @param dolisten Should this port be listened on?
510 * @return True if the port was bound successfully
512 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
514 /** Gets the GECOS (description) field of the given server.
515 * If the servername is not that of the local server, the name
516 * is passed to handling modules which will attempt to determine
517 * the GECOS that bleongs to the given servername.
518 * @param servername The servername to find the description of
519 * @return The description of this server, or of the local server
521 std::string GetServerDescription(const std::string& servername);
523 /** Find a user in the nick hash.
524 * If the user cant be found in the nick hash check the uuid hash
525 * @param nick The nickname to find
526 * @return A pointer to the user, or NULL if the user does not exist
528 User* FindNick(const std::string &nick);
530 /** Find a user in the nick hash.
531 * If the user cant be found in the nick hash check the uuid hash
532 * @param nick The nickname to find
533 * @return A pointer to the user, or NULL if the user does not exist
535 User* FindNick(const char* nick);
537 /** Find a user in the nick hash ONLY
539 User* FindNickOnly(const char* nick);
541 /** Find a user in the nick hash ONLY
543 User* FindNickOnly(const std::string &nick);
545 /** Find a channel in the channels hash
546 * @param chan The channel to find
547 * @return A pointer to the channel, or NULL if the channel does not exist
549 Channel* FindChan(const std::string &chan);
551 /** Find a channel in the channels hash
552 * @param chan The channel to find
553 * @return A pointer to the channel, or NULL if the channel does not exist
555 Channel* FindChan(const char* chan);
557 /** Check we aren't running as root, and exit if we are
558 * @return Depending on the configuration, this function may never return
562 /** Determine the right path for, and open, the logfile
563 * @param argv The argv passed to main() initially, used to calculate program path
564 * @param argc The argc passed to main() initially, used to calculate program path
565 * @return True if the log could be opened, false if otherwise
567 bool OpenLog(char** argv, int argc);
569 /** Return true if a channel name is valid
570 * @param chname A channel name to verify
571 * @return True if the name is valid
573 caller2<bool, const char*, size_t> IsChannel;
575 /** Return true if str looks like a server ID
576 * @param string to check against
578 caller1<bool, const std::string&> IsSID;
580 /** Rehash the local server
582 caller1<void, const std::string&> Rehash;
584 /** Handles incoming signals after being set
585 * @param signal the signal recieved
587 void SignalHandler(int signal);
589 /** Sets the signal recieved
590 * @param signal the signal recieved
592 static void SetSignal(int signal);
594 /** Causes the server to exit after unloading modules and
595 * closing all open file descriptors.
597 * @param status The exit code to give to the operating system
598 * (See the ExitStatus enum for valid values)
600 void Exit(int status);
602 /** Causes the server to exit immediately with exit code 0.
603 * The status code is required for signal handlers, and ignored.
605 static void QuickExit(int status);
607 /** Return a count of channels on the network
608 * @return The number of channels
612 /** Send an error notice to all local users, opered and unopered
613 * @param s The error string to send
615 void SendError(const std::string &s);
617 /** Return true if a nickname is valid
618 * @param n A nickname to verify
619 * @return True if the nick is valid
621 caller2<bool, const char*, size_t> IsNick;
623 /** Return true if an ident is valid
624 * @param An ident to verify
625 * @return True if the ident is valid
627 caller1<bool, const char*> IsIdent;
629 /** Add a dns Resolver class to this server's active set
630 * @param r The resolver to add
631 * @param cached If this value is true, then the cache will
632 * be searched for the DNS result, immediately. If the value is
633 * false, then a request will be sent to the nameserver, and the
634 * result will not be immediately available. You should usually
635 * use the boolean value which you passed to the Resolver
636 * constructor, which Resolver will set appropriately depending
637 * on if cached results are available and haven't expired. It is
638 * however safe to force this value to false, forcing a remote DNS
639 * lookup, but not an update of the cache.
640 * @return True if the operation completed successfully. Note that
641 * if this method returns true, you should not attempt to access
642 * the resolver class you pass it after this call, as depending upon
643 * the request given, the object may be deleted!
645 bool AddResolver(Resolver* r, bool cached);
647 /** Add a command to this server's command parser
648 * @param f A Command command handler object to add
649 * @throw ModuleException Will throw ModuleExcption if the command already exists
651 inline void AddCommand(Command *f)
653 Modules->AddService(*f);
656 /** Send a modechange.
657 * The parameters provided are identical to that sent to the
658 * handler for class cmd_mode.
659 * @param parameters The mode parameters
660 * @param user The user to send error messages to
662 void SendMode(const std::vector<std::string>& parameters, User *user);
664 /** Send a modechange and route it to the network.
665 * The parameters provided are identical to that sent to the
666 * handler for class cmd_mode.
667 * @param parameters The mode parameters
668 * @param user The user to send error messages to
670 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
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 * @param str The literal string to match against
675 * @param mask The glob pattern to match against.
676 * @param map The character map to use when matching.
678 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
679 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
681 /** Match two strings using pattern matching, optionally, with a map
682 * to check case against (may be NULL). If map is null, match will be case insensitive.
683 * Supports CIDR patterns as well as globs.
684 * @param str The literal string to match against
685 * @param mask The glob or CIDR pattern to match against.
686 * @param map The character map to use when matching.
688 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
689 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
691 /** Call the handler for a given command.
692 * @param commandname The command whos handler you wish to call
693 * @param parameters The mode parameters
694 * @param user The user to execute the command as
695 * @return True if the command handler was called successfully
697 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
699 /** Return true if the command is a module-implemented command and the given parameters are valid for it
700 * @param commandname The command name to check
701 * @param pcnt The parameter count
702 * @param user The user to test-execute the command as
703 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
705 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
707 /** Return true if the given parameter is a valid nick!user\@host mask
708 * @param mask A nick!user\@host masak to match against
709 * @return True i the mask is valid
711 bool IsValidMask(const std::string &mask);
713 /** Strips all color codes from the given string
714 * @param sentence The string to strip from
716 static void StripColor(std::string &sentence);
718 /** Parses color codes from string values to actual color codes
719 * @param input The data to process
721 static void ProcessColors(file_cache& input);
723 /** Rehash the local server
727 /** Check if the given nickmask matches too many users, send errors to the given user
728 * @param nick A nickmask to match against
729 * @param user A user to send error text to
730 * @return True if the nick matches too many users
732 bool NickMatchesEveryone(const std::string &nick, User* user);
734 /** Check if the given IP mask matches too many users, send errors to the given user
735 * @param ip An ipmask to match against
736 * @param user A user to send error text to
737 * @return True if the ip matches too many users
739 bool IPMatchesEveryone(const std::string &ip, User* user);
741 /** Check if the given hostmask matches too many users, send errors to the given user
742 * @param mask A hostmask to match against
743 * @param user A user to send error text to
744 * @return True if the host matches too many users
746 bool HostMatchesEveryone(const std::string &mask, User* user);
748 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
749 * @param str A string containing a time in the form 1y2w3d4h6m5s
750 * (one year, two weeks, three days, four hours, six minutes and five seconds)
751 * @return The total number of seconds
753 long Duration(const std::string &str);
755 /** Attempt to compare a password to a string from the config file.
756 * This will be passed to handling modules which will compare the data
757 * against possible hashed equivalents in the input string.
758 * @param ex The object (user, server, whatever) causing the comparison.
759 * @param data The data from the config file
760 * @param input The data input by the oper
761 * @param hashtype The hash from the config file
762 * @return 0 if the strings match, 1 or -1 if they do not
764 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
766 /** Check if a given server is a uline.
767 * An empty string returns true, this is by design.
768 * @param server The server to check for uline status
769 * @return True if the server is a uline OR the string is empty
771 bool ULine(const std::string& server);
773 /** Returns true if the uline is 'silent' (doesnt generate
774 * remote connect notices etc).
776 bool SilentULine(const std::string& server);
778 /** Returns the full version string of this ircd
779 * @return The version string
781 std::string GetVersionString(bool rawversion = false);
783 /** Attempt to write the process id to a given file
784 * @param filename The PID file to attempt to write to
785 * @return This function may bail if the file cannot be written
787 void WritePID(const std::string &filename);
789 /** This constructor initialises all the subsystems and reads the config file.
790 * @param argc The argument count passed to main()
791 * @param argv The argument list passed to main()
792 * @throw <anything> If anything is thrown from here and makes it to
793 * you, you should probably just give up and go home. Yes, really.
794 * It's that bad. Higher level classes should catch any non-fatal exceptions.
796 InspIRCd(int argc, char** argv);
798 /** Send a line of WHOIS data to a user.
799 * @param user user to send the line to
800 * @param dest user being WHOISed
801 * @param numeric Numeric to send
802 * @param text Text of the numeric
804 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
806 /** Send a line of WHOIS data to a user.
807 * @param user user to send the line to
808 * @param dest user being WHOISed
809 * @param numeric Numeric to send
810 * @param format Format string for the numeric
811 * @param ... Parameters for the format string
813 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
817 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
819 /** Quit a user for excess flood, and if they are not
820 * fully registered yet, temporarily zline their IP.
821 * @param current user to quit
823 caller1<void, User*> FloodQuitUser;
825 /** Called to check whether a channel restriction mode applies to a user
826 * @param User that is attempting some action
827 * @param Channel that the action is being performed on
830 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
832 /** Restart the server.
833 * This function will not return. If an error occurs,
834 * it will throw an instance of CoreException.
835 * @param reason The restart reason to show to all clients
836 * @throw CoreException An instance of CoreException indicating the error from execv().
838 void Restart(const std::string &reason);
840 /** Prepare the ircd for restart or shutdown.
841 * This function unloads all modules which can be unloaded,
842 * closes all open sockets, and closes the logfile.
846 /** This copies the user and channel hash_maps into new hash maps.
847 * This frees memory used by the hash_map allocator (which it neglects
848 * to free, most of the time, using tons of ram)
850 void RehashUsersAndChans();
852 /** Resets the cached max bans value on all channels.
857 /** Return a time_t as a human-readable string.
859 std::string TimeString(time_t curtime);
861 /** Begin execution of the server.
862 * NOTE: this function NEVER returns. Internally,
863 * it will repeatedly loop.
864 * @return The return value for this function is undefined.
868 /** Adds an extban char to the 005 token.
870 void AddExtBanChar(char c);
872 char* GetReadBuffer()
874 return this->ReadBuffer;
877 friend class TestSuite;
883 class CommandModule : public Module
887 CommandModule() : cmd(this)
893 ServerInstance->Modules->AddService(cmd);
898 return Version(cmd.name, VF_VENDOR|VF_CORE);