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 /** Support for librodent -
116 * see http://www.chatspike.net/index.php?z=64
118 #define ETIREDHAMSTERS EAGAIN
120 /** Template function to convert any input type to std::string
122 template<typename T> inline std::string ConvNumeric(const T &in)
124 if (in == 0) return "0";
129 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
136 std::reverse(res,out);
140 /** Template function to convert any input type to std::string
142 inline std::string ConvToStr(const int in)
144 return ConvNumeric(in);
147 /** Template function to convert any input type to std::string
149 inline std::string ConvToStr(const long in)
151 return ConvNumeric(in);
154 /** Template function to convert any input type to std::string
156 inline std::string ConvToStr(const char* in)
161 /** Template function to convert any input type to std::string
163 inline std::string ConvToStr(const bool in)
165 return (in ? "1" : "0");
168 /** Template function to convert any input type to std::string
170 inline std::string ConvToStr(char in)
172 return std::string(in,1);
175 /** Template function to convert any input type to std::string
177 template <class T> inline std::string ConvToStr(const T &in)
179 std::stringstream tmp;
180 if (!(tmp << in)) return std::string();
184 /** Template function to convert any input type to any other type
185 * (usually an integer or numeric type)
187 template<typename T> inline long ConvToInt(const T &in)
189 std::stringstream tmp;
190 if (!(tmp << in)) return 0;
191 return atol(tmp.str().c_str());
194 /** This class contains various STATS counters
195 * It is used by the InspIRCd class, which internally
196 * has an instance of it.
201 /** Number of accepted connections
203 unsigned long statsAccept;
204 /** Number of failed accepts
206 unsigned long statsRefused;
207 /** Number of unknown commands seen
209 unsigned long statsUnknown;
210 /** Number of nickname collisions handled
212 unsigned long statsCollisions;
213 /** Number of DNS queries sent out
215 unsigned long statsDns;
216 /** Number of good 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 statsDnsGood;
221 /** Number of bad (negative) DNS replies received
222 * NOTE: This may not tally to the number sent out,
223 * due to timeouts and other latency issues.
225 unsigned long statsDnsBad;
226 /** Number of inbound connections seen
228 unsigned long statsConnects;
229 /** Total bytes of data transmitted
231 unsigned long statsSent;
232 /** Total bytes of data received
234 unsigned long statsRecv;
236 /** Cpu usage at last sample
239 /** Time QP sample was read
241 LARGE_INTEGER LastSampled;
244 LARGE_INTEGER QPFrequency;
246 /** Cpu usage at last sample
249 /** Time last sample was read
251 timespec LastSampled;
253 /** The constructor initializes all the counts to zero
256 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
257 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
262 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
263 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
264 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
265 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
266 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
267 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
268 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
269 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
273 /** The main class of the irc server.
274 * This class contains instances of all the other classes in this software.
275 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
276 * object, and a list of active Module objects, and facilities for Module
277 * objects to interact with the core system it implements.
279 class CoreExport InspIRCd
282 /** Holds the current UID. Used to generate the next one.
284 char current_uid[UUID_LENGTH];
286 /** Set up the signal handlers
290 /** Daemonize the ircd and close standard input/output streams
291 * @return True if the program daemonized succesfully
295 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
296 * @param TIME the current time
298 void DoSocketTimeouts(time_t TIME);
300 /** Increments the current UID by one.
302 void IncrementUID(int pos);
304 /** Perform background user events such as PING checks
306 void DoBackgroundUserStuff();
308 /** Returns true when all modules have done pre-registration checks on a user
309 * @param user The user to verify
310 * @return True if all modules have finished checking this user
312 bool AllModulesReportReady(LocalUser* user);
314 /** The current time, updated in the mainloop
316 struct timespec TIME;
318 /** A 64k buffer used to read socket data into
319 * NOTE: update ValidateNetBufferSize if you change this
321 char ReadBuffer[65535];
325 /** Global cull list, will be processed on next iteration
327 CullList GlobalCulls;
328 /** Actions that must happen outside of the current call stack */
329 ActionList AtomicActions;
333 IsNickHandler HandleIsNick;
334 IsIdentHandler HandleIsIdent;
335 FloodQuitUserHandler HandleFloodQuitUser;
336 OnCheckExemptionHandler HandleOnCheckExemption;
337 IsChannelHandler HandleIsChannel;
338 IsSIDHandler HandleIsSID;
339 RehashHandler HandleRehash;
340 GenRandomHandler HandleGenRandom;
342 /** 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
345 * SendMode expects a User* to send the numeric replies
346 * back to, so we create it a fake user that isnt in the user
347 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
348 * falls into the abyss :p
350 FakeUser* FakeClient;
352 /** Returns the next available UID for this server.
354 std::string GetUID();
356 static const char LogHeader[];
358 /** Find a user in the UUID hash
359 * @param uid The UUID to find
360 * @return A pointer to the user, or NULL if the user does not exist
362 User* FindUUID(const std::string &uid);
364 /** Find a user in the UUID hash
365 * @param uid The UUID to find
366 * @return A pointer to the user, or NULL if the user does not exist
368 User* FindUUID(const char *uid);
370 /** Build the ISUPPORT string by triggering all modules On005Numeric events
372 void BuildISupport();
374 /** Time this ircd was booted
378 /** Config file pathname specified on the commandline or via ./configure
380 std::string ConfigFileName;
382 ExtensionManager Extensions;
384 /** Mode handler, handles mode setting and removal
388 /** Command parser, handles client to server commands
390 CommandParser* Parser;
392 /** Socket engine, handles socket activity events
396 /** Thread engine, Handles threading where required
398 ThreadEngine* Threads;
400 /** The thread/class used to read config files in REHASH and on startup
402 ConfigReaderThread* ConfigThread;
404 /** LogManager handles logging.
408 /** ModuleManager contains everything related to loading/unloading
411 ModuleManager* Modules;
413 /** BanCacheManager is used to speed up checking of restrictions on connection
416 BanCacheManager *BanCache;
418 /** Stats class, holds miscellaneous stats counters
422 /** Server Config class, holds configuration file data
424 ServerConfig* Config;
426 /** Snomask manager - handles routing of snomask messages
431 /** DNS class, provides resolver facilities to the core and modules
435 /** Timer manager class, triggers Timer timer events
437 TimerManager* Timers;
439 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
441 XLineManager* XLines;
443 /** User manager. Various methods and data associated with users.
447 /** Channel list, a hash_map containing all channels XXX move to channel manager class
451 /** List of the open ports
453 std::vector<ListenSocket*> ports;
455 /** Set to the current signal recieved
459 /** Protocol interface, overridden by server protocol modules
461 ProtocolInterface* PI;
463 /** Holds extensible for user nickforced
465 LocalIntExt NICKForced;
467 /** Holds extensible for user operquit
469 LocalStringExt OperQuit;
471 /** Get the current time
472 * Because this only calls time() once every time around the mainloop,
473 * it is much faster than calling time() directly.
474 * @return The current time as an epoch value (time_t)
476 inline time_t Time() { return TIME.tv_sec; }
477 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
478 inline long Time_ns() { return TIME.tv_nsec; }
479 /** Update the current time. Don't call this unless you have reason to do so. */
482 /** Generate a random string with the given length
483 * @param length The length in bytes
484 * @param printable if false, the string will use characters 0-255; otherwise,
485 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
487 std::string GenRandomStr(int length, bool printable = true);
488 /** Generate a random integer.
489 * This is generally more secure than rand()
491 unsigned long GenRandomInt(unsigned long max);
493 /** Fill a buffer with random bits */
494 caller2<void, char*, size_t> GenRandom;
496 /** Bind all ports specified in the configuration file.
497 * @return The number of ports bound without error
499 int BindPorts(FailedPortList &failed_ports);
501 /** Binds a socket on an already open file descriptor
502 * @param sockfd A valid file descriptor of an open socket
503 * @param port The port number to bind to
504 * @param addr The address to bind to (IP only)
505 * @param dolisten Should this port be listened on?
506 * @return True if the port was bound successfully
508 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
510 /** Gets the GECOS (description) field of the given server.
511 * If the servername is not that of the local server, the name
512 * is passed to handling modules which will attempt to determine
513 * the GECOS that bleongs to the given servername.
514 * @param servername The servername to find the description of
515 * @return The description of this server, or of the local server
517 std::string GetServerDescription(const std::string& servername);
519 /** Find a user in the nick hash.
520 * If the user cant be found in the nick hash check the uuid hash
521 * @param nick The nickname to find
522 * @return A pointer to the user, or NULL if the user does not exist
524 User* FindNick(const std::string &nick);
526 /** Find a user in the nick hash.
527 * If the user cant be found in the nick hash check the uuid hash
528 * @param nick The nickname to find
529 * @return A pointer to the user, or NULL if the user does not exist
531 User* FindNick(const char* nick);
533 /** Find a user in the nick hash ONLY
535 User* FindNickOnly(const char* nick);
537 /** Find a user in the nick hash ONLY
539 User* FindNickOnly(const std::string &nick);
541 /** Find a channel in the channels hash
542 * @param chan The channel to find
543 * @return A pointer to the channel, or NULL if the channel does not exist
545 Channel* FindChan(const std::string &chan);
547 /** Find a channel in the channels hash
548 * @param chan The channel to find
549 * @return A pointer to the channel, or NULL if the channel does not exist
551 Channel* FindChan(const char* chan);
553 /** Check we aren't running as root, and exit if we are
554 * @return Depending on the configuration, this function may never return
558 /** Determine the right path for, and open, the logfile
559 * @param argv The argv passed to main() initially, used to calculate program path
560 * @param argc The argc passed to main() initially, used to calculate program path
561 * @return True if the log could be opened, false if otherwise
563 bool OpenLog(char** argv, int argc);
565 /** Return true if a channel name is valid
566 * @param chname A channel name to verify
567 * @return True if the name is valid
569 caller2<bool, const char*, size_t> IsChannel;
571 /** Return true if str looks like a server ID
572 * @param string to check against
574 caller1<bool, const std::string&> IsSID;
576 /** Rehash the local server
578 caller1<void, const std::string&> Rehash;
580 /** Handles incoming signals after being set
581 * @param signal the signal recieved
583 void SignalHandler(int signal);
585 /** Sets the signal recieved
586 * @param signal the signal recieved
588 static void SetSignal(int signal);
590 /** Causes the server to exit after unloading modules and
591 * closing all open file descriptors.
593 * @param status The exit code to give to the operating system
594 * (See the ExitStatus enum for valid values)
596 void Exit(int status);
598 /** Causes the server to exit immediately with exit code 0.
599 * The status code is required for signal handlers, and ignored.
601 static void QuickExit(int status);
603 /** Return a count of channels on the network
604 * @return The number of channels
608 /** Send an error notice to all local users, opered and unopered
609 * @param s The error string to send
611 void SendError(const std::string &s);
613 /** Return true if a nickname is valid
614 * @param n A nickname to verify
615 * @return True if the nick is valid
617 caller2<bool, const char*, size_t> IsNick;
619 /** Return true if an ident is valid
620 * @param An ident to verify
621 * @return True if the ident is valid
623 caller1<bool, const char*> IsIdent;
625 /** Add a dns Resolver class to this server's active set
626 * @param r The resolver to add
627 * @param cached If this value is true, then the cache will
628 * be searched for the DNS result, immediately. If the value is
629 * false, then a request will be sent to the nameserver, and the
630 * result will not be immediately available. You should usually
631 * use the boolean value which you passed to the Resolver
632 * constructor, which Resolver will set appropriately depending
633 * on if cached results are available and haven't expired. It is
634 * however safe to force this value to false, forcing a remote DNS
635 * lookup, but not an update of the cache.
636 * @return True if the operation completed successfully. Note that
637 * if this method returns true, you should not attempt to access
638 * the resolver class you pass it after this call, as depending upon
639 * the request given, the object may be deleted!
641 bool AddResolver(Resolver* r, bool cached);
643 /** Add a command to this server's command parser
644 * @param f A Command command handler object to add
645 * @throw ModuleException Will throw ModuleExcption if the command already exists
647 inline void AddCommand(Command *f)
649 Modules->AddService(*f);
652 /** Send a modechange.
653 * The parameters provided are identical to that sent to the
654 * handler for class cmd_mode.
655 * @param parameters The mode parameters
656 * @param user The user to send error messages to
658 void SendMode(const std::vector<std::string>& parameters, User *user);
660 /** Send a modechange and route it to the network.
661 * The parameters provided are identical to that sent to the
662 * handler for class cmd_mode.
663 * @param parameters The mode parameters
664 * @param user The user to send error messages to
666 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
668 /** Match two strings using pattern matching, optionally, with a map
669 * to check case against (may be NULL). If map is null, match will be case insensitive.
670 * @param str The literal string to match against
671 * @param mask The glob pattern to match against.
672 * @param map The character map to use when matching.
674 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
675 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
677 /** Match two strings using pattern matching, optionally, with a map
678 * to check case against (may be NULL). If map is null, match will be case insensitive.
679 * Supports CIDR patterns as well as globs.
680 * @param str The literal string to match against
681 * @param mask The glob or CIDR pattern to match against.
682 * @param map The character map to use when matching.
684 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
685 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
687 /** Call the handler for a given command.
688 * @param commandname The command whos handler you wish to call
689 * @param parameters The mode parameters
690 * @param user The user to execute the command as
691 * @return True if the command handler was called successfully
693 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
695 /** Return true if the command is a module-implemented command and the given parameters are valid for it
696 * @param commandname The command name to check
697 * @param pcnt The parameter count
698 * @param user The user to test-execute the command as
699 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
701 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
703 /** Return true if the given parameter is a valid nick!user\@host mask
704 * @param mask A nick!user\@host masak to match against
705 * @return True i the mask is valid
707 bool IsValidMask(const std::string &mask);
709 /** Strips all color codes from the given string
710 * @param sentence The string to strip from
712 static void StripColor(std::string &sentence);
714 /** Parses color codes from string values to actual color codes
715 * @param input The data to process
717 static void ProcessColors(file_cache& input);
719 /** Rehash the local server
723 /** Check if the given nickmask matches too many users, send errors to the given user
724 * @param nick A nickmask to match against
725 * @param user A user to send error text to
726 * @return True if the nick matches too many users
728 bool NickMatchesEveryone(const std::string &nick, User* user);
730 /** Check if the given IP mask matches too many users, send errors to the given user
731 * @param ip An ipmask to match against
732 * @param user A user to send error text to
733 * @return True if the ip matches too many users
735 bool IPMatchesEveryone(const std::string &ip, User* user);
737 /** Check if the given hostmask matches too many users, send errors to the given user
738 * @param mask A hostmask to match against
739 * @param user A user to send error text to
740 * @return True if the host matches too many users
742 bool HostMatchesEveryone(const std::string &mask, User* user);
744 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
745 * @param str A string containing a time in the form 1y2w3d4h6m5s
746 * (one year, two weeks, three days, four hours, six minutes and five seconds)
747 * @return The total number of seconds
749 long Duration(const std::string &str);
751 /** Attempt to compare a password to a string from the config file.
752 * This will be passed to handling modules which will compare the data
753 * against possible hashed equivalents in the input string.
754 * @param ex The object (user, server, whatever) causing the comparison.
755 * @param data The data from the config file
756 * @param input The data input by the oper
757 * @param hashtype The hash from the config file
758 * @return 0 if the strings match, 1 or -1 if they do not
760 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
762 /** Check if a given server is a uline.
763 * An empty string returns true, this is by design.
764 * @param server The server to check for uline status
765 * @return True if the server is a uline OR the string is empty
767 bool ULine(const std::string& server);
769 /** Returns true if the uline is 'silent' (doesnt generate
770 * remote connect notices etc).
772 bool SilentULine(const std::string& server);
774 /** Returns the full version string of this ircd
775 * @return The version string
777 std::string GetVersionString(bool rawversion = false);
779 /** Attempt to write the process id to a given file
780 * @param filename The PID file to attempt to write to
781 * @return This function may bail if the file cannot be written
783 void WritePID(const std::string &filename);
785 /** This constructor initialises all the subsystems and reads the config file.
786 * @param argc The argument count passed to main()
787 * @param argv The argument list passed to main()
788 * @throw <anything> If anything is thrown from here and makes it to
789 * you, you should probably just give up and go home. Yes, really.
790 * It's that bad. Higher level classes should catch any non-fatal exceptions.
792 InspIRCd(int argc, char** argv);
794 /** Send a line of WHOIS data to a user.
795 * @param user user to send the line to
796 * @param dest user being WHOISed
797 * @param numeric Numeric to send
798 * @param text Text of the numeric
800 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
802 /** Send a line of WHOIS data to a user.
803 * @param user user to send the line to
804 * @param dest user being WHOISed
805 * @param numeric Numeric to send
806 * @param format Format string for the numeric
807 * @param ... Parameters for the format string
809 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
813 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
815 /** Quit a user for excess flood, and if they are not
816 * fully registered yet, temporarily zline their IP.
817 * @param current user to quit
819 caller1<void, User*> FloodQuitUser;
821 /** Called to check whether a channel restriction mode applies to a user
822 * @param User that is attempting some action
823 * @param Channel that the action is being performed on
826 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
828 /** Restart the server.
829 * This function will not return. If an error occurs,
830 * it will throw an instance of CoreException.
831 * @param reason The restart reason to show to all clients
832 * @throw CoreException An instance of CoreException indicating the error from execv().
834 void Restart(const std::string &reason);
836 /** Prepare the ircd for restart or shutdown.
837 * This function unloads all modules which can be unloaded,
838 * closes all open sockets, and closes the logfile.
842 /** This copies the user and channel hash_maps into new hash maps.
843 * This frees memory used by the hash_map allocator (which it neglects
844 * to free, most of the time, using tons of ram)
846 void RehashUsersAndChans();
848 /** Resets the cached max bans value on all channels.
853 /** Return a time_t as a human-readable string.
855 std::string TimeString(time_t curtime);
857 /** Begin execution of the server.
858 * NOTE: this function NEVER returns. Internally,
859 * it will repeatedly loop.
860 * @return The return value for this function is undefined.
864 /** Adds an extban char to the 005 token.
866 void AddExtBanChar(char c);
868 char* GetReadBuffer()
870 return this->ReadBuffer;
873 friend class TestSuite;
879 class CommandModule : public Module
883 CommandModule() : cmd(this)
889 ServerInstance->Modules->AddService(cmd);
894 return Version(cmd.name, VF_VENDOR|VF_CORE);