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/>.
28 #define _FILE_OFFSET_BITS 64
29 #ifndef _LARGEFILE_SOURCE
30 #define _LARGEFILE_SOURCE
37 #include "inspircd_win32wrapper.h"
38 /** Windows defines these already */
43 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
45 #define CUSTOM_PRINTF(STRING, FIRST)
48 #if defined __clang__ || defined __GNUC__
49 # define DEPRECATED_METHOD(function) function __attribute__((deprecated))
50 #elif defined _MSC_VER
51 # define DEPRECATED_METHOD(function) __declspec(deprecated) function
53 # pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
54 # define DEPRECATED_METHOD(function) function
57 // Required system headers.
69 #if defined _LIBCPP_VERSION || defined _WIN32
71 # include <unordered_map>
73 # define TR1NS std::tr1
74 # include <tr1/unordered_map>
87 #include "consolecolors.h"
89 CoreExport extern InspIRCd* ServerInstance;
92 #include "cull_list.h"
93 #include "extensible.h"
101 #include "usermanager.h"
104 #include "command_parse.h"
106 #include "socketengine.h"
107 #include "snomasks.h"
108 #include "filelogger.h"
110 #include "threadengine.h"
111 #include "configreader.h"
112 #include "inspstring.h"
113 #include "protocol.h"
116 #warning Potentially broken system, PATH_MAX undefined
117 #define PATH_MAX 4096
121 * Used to define the maximum number of parameters a command may have.
123 #define MAXPARAMETERS 127
125 /** Returned by some functions to indicate failure.
129 /** Template function to convert any input type to std::string
131 template<typename T> inline std::string ConvNumeric(const T &in)
133 if (in == 0) return "0";
138 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
145 std::reverse(res,out);
149 /** Template function to convert any input type to std::string
151 inline std::string ConvToStr(const int in)
153 return ConvNumeric(in);
156 /** Template function to convert any input type to std::string
158 inline std::string ConvToStr(const long in)
160 return ConvNumeric(in);
163 /** Template function to convert any input type to std::string
165 inline std::string ConvToStr(const char* in)
170 /** Template function to convert any input type to std::string
172 inline std::string ConvToStr(const bool in)
174 return (in ? "1" : "0");
177 /** Template function to convert any input type to std::string
179 inline std::string ConvToStr(char in)
181 return std::string(in,1);
184 /** Template function to convert any input type to std::string
186 template <class T> inline std::string ConvToStr(const T &in)
188 std::stringstream tmp;
189 if (!(tmp << in)) return std::string();
193 /** Template function to convert any input type to any other type
194 * (usually an integer or numeric type)
196 template<typename T> inline long ConvToInt(const T &in)
198 std::stringstream tmp;
199 if (!(tmp << in)) return 0;
200 return atol(tmp.str().c_str());
203 /** This class contains various STATS counters
204 * It is used by the InspIRCd class, which internally
205 * has an instance of it.
210 /** Number of accepted connections
212 unsigned long statsAccept;
213 /** Number of failed accepts
215 unsigned long statsRefused;
216 /** Number of unknown commands seen
218 unsigned long statsUnknown;
219 /** Number of nickname collisions handled
221 unsigned long statsCollisions;
222 /** Number of DNS queries sent out
224 unsigned long statsDns;
225 /** Number of good 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 statsDnsGood;
230 /** Number of bad (negative) DNS replies received
231 * NOTE: This may not tally to the number sent out,
232 * due to timeouts and other latency issues.
234 unsigned long statsDnsBad;
235 /** Number of inbound connections seen
237 unsigned long statsConnects;
238 /** Total bytes of data transmitted
240 unsigned long statsSent;
241 /** Total bytes of data received
243 unsigned long statsRecv;
245 /** Cpu usage at last sample
248 /** Time QP sample was read
250 LARGE_INTEGER LastSampled;
253 LARGE_INTEGER QPFrequency;
255 /** Cpu usage at last sample
258 /** Time last sample was read
260 timespec LastSampled;
262 /** The constructor initializes all the counts to zero
265 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
266 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
271 /** This class manages the generation and transmission of ISUPPORT. */
272 class CoreExport ISupportManager
275 /** The generated lines which are sent to clients. */
276 std::vector<std::string> Lines;
279 /** (Re)build the ISUPPORT vector. */
282 /** Returns the std::vector of ISUPPORT lines. */
283 const std::vector<std::string>& GetLines()
288 /** Send the 005 numerics (ISUPPORT) to a user. */
289 void SendTo(LocalUser* user);
292 DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
293 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
294 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
295 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
296 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
297 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
299 /** The main class of the irc server.
300 * This class contains instances of all the other classes in this software.
301 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
302 * object, and a list of active Module objects, and facilities for Module
303 * objects to interact with the core system it implements.
305 class CoreExport InspIRCd
308 /** Set up the signal handlers
312 /** Daemonize the ircd and close standard input/output streams
313 * @return True if the program daemonized succesfully
317 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
318 * @param TIME the current time
320 void DoSocketTimeouts(time_t TIME);
322 /** Perform background user events such as PING checks
324 void DoBackgroundUserStuff();
326 /** Returns true when all modules have done pre-registration checks on a user
327 * @param user The user to verify
328 * @return True if all modules have finished checking this user
330 bool AllModulesReportReady(LocalUser* user);
332 /** The current time, updated in the mainloop
334 struct timespec TIME;
336 /** A 64k buffer used to read socket data into
337 * NOTE: update ValidateNetBufferSize if you change this
339 char ReadBuffer[65535];
345 /** Global cull list, will be processed on next iteration
347 CullList GlobalCulls;
348 /** Actions that must happen outside of the current call stack */
349 ActionList AtomicActions;
353 IsNickHandler HandleIsNick;
354 IsIdentHandler HandleIsIdent;
355 OnCheckExemptionHandler HandleOnCheckExemption;
356 IsChannelHandler HandleIsChannel;
357 RehashHandler HandleRehash;
358 GenRandomHandler HandleGenRandom;
360 /** 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
363 * SendMode expects a User* to send the numeric replies
364 * back to, so we create it a fake user that isnt in the user
365 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
366 * falls into the abyss :p
368 FakeUser* FakeClient;
370 static const char LogHeader[];
372 /** Find a user in the UUID hash
373 * @param uid The UUID to find
374 * @return A pointer to the user, or NULL if the user does not exist
376 User* FindUUID(const std::string &uid);
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 /** Manages the generation and transmission of ISUPPORT. */
476 ISupportManager ISupport;
478 /** Get the current time
479 * Because this only calls time() once every time around the mainloop,
480 * it is much faster than calling time() directly.
481 * @return The current time as an epoch value (time_t)
483 inline time_t Time() { return TIME.tv_sec; }
484 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
485 inline long Time_ns() { return TIME.tv_nsec; }
486 /** Update the current time. Don't call this unless you have reason to do so. */
489 /** Generate a random string with the given length
490 * @param length The length in bytes
491 * @param printable if false, the string will use characters 0-255; otherwise,
492 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
494 std::string GenRandomStr(int length, bool printable = true);
495 /** Generate a random integer.
496 * This is generally more secure than rand()
498 unsigned long GenRandomInt(unsigned long max);
500 /** Fill a buffer with random bits */
501 caller2<void, char*, size_t> GenRandom;
503 /** Bind all ports specified in the configuration file.
504 * @return The number of ports bound without error
506 int BindPorts(FailedPortList &failed_ports);
508 /** Binds a socket on an already open file descriptor
509 * @param sockfd A valid file descriptor of an open socket
510 * @param port The port number to bind to
511 * @param addr The address to bind to (IP only)
512 * @param dolisten Should this port be listened on?
513 * @return True if the port was bound successfully
515 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
517 /** Gets the GECOS (description) field of the given server.
518 * If the servername is not that of the local server, the name
519 * is passed to handling modules which will attempt to determine
520 * the GECOS that bleongs to the given servername.
521 * @param servername The servername to find the description of
522 * @return The description of this server, or of the local server
524 std::string GetServerDescription(const std::string& servername);
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 std::string &nick);
533 /** Find a user in the nick hash ONLY
535 User* FindNickOnly(const std::string &nick);
537 /** Find a channel in the channels hash
538 * @param chan The channel to find
539 * @return A pointer to the channel, or NULL if the channel does not exist
541 Channel* FindChan(const std::string &chan);
543 /** Check we aren't running as root, and exit if we are
544 * @return Depending on the configuration, this function may never return
548 /** Determine the right path for, and open, the logfile
549 * @param argv The argv passed to main() initially, used to calculate program path
550 * @param argc The argc passed to main() initially, used to calculate program path
551 * @return True if the log could be opened, false if otherwise
553 bool OpenLog(char** argv, int argc);
555 /** Return true if a channel name is valid
556 * @param chname A channel name to verify
557 * @return True if the name is valid
559 caller2<bool, const std::string&, size_t> IsChannel;
561 /** Return true if str looks like a server ID
562 * @param string to check against
564 static bool IsSID(const std::string& sid);
566 /** Rehash the local server
568 caller1<void, const std::string&> Rehash;
570 /** Handles incoming signals after being set
571 * @param signal the signal recieved
573 void SignalHandler(int signal);
575 /** Sets the signal recieved
576 * @param signal the signal recieved
578 static void SetSignal(int signal);
580 /** Causes the server to exit after unloading modules and
581 * closing all open file descriptors.
583 * @param status The exit code to give to the operating system
584 * (See the ExitStatus enum for valid values)
586 void Exit(int status);
588 /** Causes the server to exit immediately with exit code 0.
589 * The status code is required for signal handlers, and ignored.
591 static void QuickExit(int status);
593 /** Return a count of channels on the network
594 * @return The number of channels
598 /** Send an error notice to all local users, opered and unopered
599 * @param s The error string to send
601 void SendError(const std::string &s);
603 /** Return true if a nickname is valid
604 * @param n A nickname to verify
605 * @return True if the nick is valid
607 caller2<bool, const std::string&, size_t> IsNick;
609 /** Return true if an ident is valid
610 * @param An ident to verify
611 * @return True if the ident is valid
613 caller1<bool, const std::string&> IsIdent;
615 /** Add a dns Resolver class to this server's active set
616 * @param r The resolver to add
617 * @param cached If this value is true, then the cache will
618 * be searched for the DNS result, immediately. If the value is
619 * false, then a request will be sent to the nameserver, and the
620 * result will not be immediately available. You should usually
621 * use the boolean value which you passed to the Resolver
622 * constructor, which Resolver will set appropriately depending
623 * on if cached results are available and haven't expired. It is
624 * however safe to force this value to false, forcing a remote DNS
625 * lookup, but not an update of the cache.
626 * @return True if the operation completed successfully. Note that
627 * if this method returns true, you should not attempt to access
628 * the resolver class you pass it after this call, as depending upon
629 * the request given, the object may be deleted!
631 bool AddResolver(Resolver* r, bool cached);
633 /** Add a command to this server's command parser
634 * @param f A Command command handler object to add
635 * @throw ModuleException Will throw ModuleExcption if the command already exists
637 inline void AddCommand(Command *f)
639 Modules->AddService(*f);
642 /** Send a modechange.
643 * The parameters provided are identical to that sent to the
644 * handler for class cmd_mode.
645 * @param parameters The mode parameters
646 * @param user The user to send error messages to
648 void SendMode(const std::vector<std::string>& parameters, User *user);
650 /** Send a modechange and route it to the network.
651 * The parameters provided are identical to that sent to the
652 * handler for class cmd_mode.
653 * @param parameters The mode parameters
654 * @param user The user to send error messages to
656 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
658 /** Match two strings using pattern matching, optionally, with a map
659 * to check case against (may be NULL). If map is null, match will be case insensitive.
660 * @param str The literal string to match against
661 * @param mask The glob pattern to match against.
662 * @param map The character map to use when matching.
664 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
665 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
667 /** Match two strings using pattern matching, optionally, with a map
668 * to check case against (may be NULL). If map is null, match will be case insensitive.
669 * Supports CIDR patterns as well as globs.
670 * @param str The literal string to match against
671 * @param mask The glob or CIDR pattern to match against.
672 * @param map The character map to use when matching.
674 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
675 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
677 /** Return true if the given parameter is a valid nick!user\@host mask
678 * @param mask A nick!user\@host masak to match against
679 * @return True i the mask is valid
681 bool IsValidMask(const std::string &mask);
683 /** Strips all color codes from the given string
684 * @param sentence The string to strip from
686 static void StripColor(std::string &sentence);
688 /** Parses color codes from string values to actual color codes
689 * @param input The data to process
691 static void ProcessColors(file_cache& input);
693 /** Rehash the local server
697 /** Check if the given nickmask matches too many users, send errors to the given user
698 * @param nick A nickmask to match against
699 * @param user A user to send error text to
700 * @return True if the nick matches too many users
702 bool NickMatchesEveryone(const std::string &nick, User* user);
704 /** Check if the given IP mask matches too many users, send errors to the given user
705 * @param ip An ipmask to match against
706 * @param user A user to send error text to
707 * @return True if the ip matches too many users
709 bool IPMatchesEveryone(const std::string &ip, User* user);
711 /** Check if the given hostmask matches too many users, send errors to the given user
712 * @param mask A hostmask to match against
713 * @param user A user to send error text to
714 * @return True if the host matches too many users
716 bool HostMatchesEveryone(const std::string &mask, User* user);
718 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
719 * @param str A string containing a time in the form 1y2w3d4h6m5s
720 * (one year, two weeks, three days, four hours, six minutes and five seconds)
721 * @return The total number of seconds
723 static unsigned long Duration(const std::string& str);
725 /** Attempt to compare a password to a string from the config file.
726 * This will be passed to handling modules which will compare the data
727 * against possible hashed equivalents in the input string.
728 * @param ex The object (user, server, whatever) causing the comparison.
729 * @param data The data from the config file
730 * @param input The data input by the oper
731 * @param hashtype The hash from the config file
732 * @return 0 if the strings match, 1 or -1 if they do not
734 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
736 /** Check if a given server is a uline.
737 * An empty string returns true, this is by design.
738 * @param server The server to check for uline status
739 * @return True if the server is a uline OR the string is empty
741 bool ULine(const std::string& server);
743 /** Returns true if the uline is 'silent' (doesnt generate
744 * remote connect notices etc).
746 bool SilentULine(const std::string& server);
748 /** Returns the full version string of this ircd
749 * @return The version string
751 std::string GetVersionString(bool rawversion = false);
753 /** Attempt to write the process id to a given file
754 * @param filename The PID file to attempt to write to
755 * @return This function may bail if the file cannot be written
757 void WritePID(const std::string &filename);
759 /** This constructor initialises all the subsystems and reads the config file.
760 * @param argc The argument count passed to main()
761 * @param argv The argument list passed to main()
762 * @throw <anything> If anything is thrown from here and makes it to
763 * you, you should probably just give up and go home. Yes, really.
764 * It's that bad. Higher level classes should catch any non-fatal exceptions.
766 InspIRCd(int argc, char** argv);
768 /** Send a line of WHOIS data to a user.
769 * @param user user to send the line to
770 * @param dest user being WHOISed
771 * @param numeric Numeric to send
772 * @param text Text of the numeric
774 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
776 /** Send a line of WHOIS data to a user.
777 * @param user user to send the line to
778 * @param dest user being WHOISed
779 * @param numeric Numeric to send
780 * @param format Format string for the numeric
781 * @param ... Parameters for the format string
783 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
785 /** Called to check whether a channel restriction mode applies to a user
786 * @param User that is attempting some action
787 * @param Channel that the action is being performed on
790 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
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 /** Return a time_t as a human-readable string.
808 std::string TimeString(time_t curtime);
810 /** Begin execution of the server.
811 * NOTE: this function NEVER returns. Internally,
812 * it will repeatedly loop.
813 * @return The return value for this function is undefined.
817 char* GetReadBuffer()
819 return this->ReadBuffer;
826 class CommandModule : public Module
830 CommandModule() : cmd(this)
836 ServerInstance->Modules->AddService(cmd);
841 return Version(cmd.name, VF_VENDOR|VF_CORE);