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.
71 # include <unordered_map>
73 # include <tr1/unordered_map>
86 #include "consolecolors.h"
88 CoreExport extern InspIRCd* ServerInstance;
91 #include "cull_list.h"
92 #include "extensible.h"
100 #include "usermanager.h"
103 #include "command_parse.h"
105 #include "socketengine.h"
106 #include "snomasks.h"
107 #include "filelogger.h"
109 #include "threadengine.h"
110 #include "configreader.h"
111 #include "inspstring.h"
112 #include "protocol.h"
115 #warning Potentially broken system, PATH_MAX undefined
116 #define PATH_MAX 4096
120 * Used to define the maximum number of parameters a command may have.
122 #define MAXPARAMETERS 127
124 /** Returned by some functions to indicate failure.
128 /** Template function to convert any input type to std::string
130 template<typename T> inline std::string ConvNumeric(const T &in)
132 if (in == 0) return "0";
137 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
144 std::reverse(res,out);
148 /** Template function to convert any input type to std::string
150 inline std::string ConvToStr(const int in)
152 return ConvNumeric(in);
155 /** Template function to convert any input type to std::string
157 inline std::string ConvToStr(const long in)
159 return ConvNumeric(in);
162 /** Template function to convert any input type to std::string
164 inline std::string ConvToStr(const char* in)
169 /** Template function to convert any input type to std::string
171 inline std::string ConvToStr(const bool in)
173 return (in ? "1" : "0");
176 /** Template function to convert any input type to std::string
178 inline std::string ConvToStr(char in)
180 return std::string(in,1);
183 /** Template function to convert any input type to std::string
185 template <class T> inline std::string ConvToStr(const T &in)
187 std::stringstream tmp;
188 if (!(tmp << in)) return std::string();
192 /** Template function to convert any input type to any other type
193 * (usually an integer or numeric type)
195 template<typename T> inline long ConvToInt(const T &in)
197 std::stringstream tmp;
198 if (!(tmp << in)) return 0;
199 return atol(tmp.str().c_str());
202 /** This class contains various STATS counters
203 * It is used by the InspIRCd class, which internally
204 * has an instance of it.
209 /** Number of accepted connections
211 unsigned long statsAccept;
212 /** Number of failed accepts
214 unsigned long statsRefused;
215 /** Number of unknown commands seen
217 unsigned long statsUnknown;
218 /** Number of nickname collisions handled
220 unsigned long statsCollisions;
221 /** Number of DNS queries sent out
223 unsigned long statsDns;
224 /** Number of good DNS replies received
225 * NOTE: This may not tally to the number sent out,
226 * due to timeouts and other latency issues.
228 unsigned long statsDnsGood;
229 /** Number of bad (negative) DNS replies received
230 * NOTE: This may not tally to the number sent out,
231 * due to timeouts and other latency issues.
233 unsigned long statsDnsBad;
234 /** Number of inbound connections seen
236 unsigned long statsConnects;
237 /** Total bytes of data transmitted
239 unsigned long statsSent;
240 /** Total bytes of data received
242 unsigned long statsRecv;
244 /** Cpu usage at last sample
247 /** Time QP sample was read
249 LARGE_INTEGER LastSampled;
252 LARGE_INTEGER QPFrequency;
254 /** Cpu usage at last sample
257 /** Time last sample was read
259 timespec LastSampled;
261 /** The constructor initializes all the counts to zero
264 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
265 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
270 /** This class manages the generation and transmission of ISUPPORT. */
271 class CoreExport ISupportManager
274 /** The generated lines which are sent to clients. */
275 std::vector<std::string> Lines;
278 /** (Re)build the ISUPPORT vector. */
281 /** Returns the std::vector of ISUPPORT lines. */
282 const std::vector<std::string>& GetLines()
287 /** Send the 005 numerics (ISUPPORT) to a user. */
288 void SendTo(LocalUser* user);
291 DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
292 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
293 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
294 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
295 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
296 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
300 /** The main class of the irc server.
301 * This class contains instances of all the other classes in this software.
302 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
303 * object, and a list of active Module objects, and facilities for Module
304 * objects to interact with the core system it implements.
306 class CoreExport InspIRCd
309 /** Holds the current UID. Used to generate the next one.
311 char current_uid[UUID_LENGTH];
313 /** Set up the signal handlers
317 /** Daemonize the ircd and close standard input/output streams
318 * @return True if the program daemonized succesfully
322 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
323 * @param TIME the current time
325 void DoSocketTimeouts(time_t TIME);
327 /** Increments the current UID by one.
329 void IncrementUID(int pos);
331 /** Perform background user events such as PING checks
333 void DoBackgroundUserStuff();
335 /** Returns true when all modules have done pre-registration checks on a user
336 * @param user The user to verify
337 * @return True if all modules have finished checking this user
339 bool AllModulesReportReady(LocalUser* user);
341 /** The current time, updated in the mainloop
343 struct timespec TIME;
345 /** A 64k buffer used to read socket data into
346 * NOTE: update ValidateNetBufferSize if you change this
348 char ReadBuffer[65535];
352 /** Global cull list, will be processed on next iteration
354 CullList GlobalCulls;
355 /** Actions that must happen outside of the current call stack */
356 ActionList AtomicActions;
360 IsNickHandler HandleIsNick;
361 IsIdentHandler HandleIsIdent;
362 OnCheckExemptionHandler HandleOnCheckExemption;
363 IsChannelHandler HandleIsChannel;
364 RehashHandler HandleRehash;
365 GenRandomHandler HandleGenRandom;
367 /** 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
370 * SendMode expects a User* to send the numeric replies
371 * back to, so we create it a fake user that isnt in the user
372 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
373 * falls into the abyss :p
375 FakeUser* FakeClient;
377 /** Returns the next available UID for this server.
379 std::string GetUID();
381 static const char LogHeader[];
383 /** Find a user in the UUID hash
384 * @param uid The UUID to find
385 * @return A pointer to the user, or NULL if the user does not exist
387 User* FindUUID(const std::string &uid);
389 /** Find a user in the UUID hash
390 * @param uid The UUID to find
391 * @return A pointer to the user, or NULL if the user does not exist
393 User* FindUUID(const char *uid);
395 /** Time this ircd was booted
399 /** Config file pathname specified on the commandline or via ./configure
401 std::string ConfigFileName;
403 ExtensionManager Extensions;
405 /** Mode handler, handles mode setting and removal
409 /** Command parser, handles client to server commands
411 CommandParser* Parser;
413 /** Socket engine, handles socket activity events
417 /** Thread engine, Handles threading where required
419 ThreadEngine* Threads;
421 /** The thread/class used to read config files in REHASH and on startup
423 ConfigReaderThread* ConfigThread;
425 /** LogManager handles logging.
429 /** ModuleManager contains everything related to loading/unloading
432 ModuleManager* Modules;
434 /** BanCacheManager is used to speed up checking of restrictions on connection
437 BanCacheManager *BanCache;
439 /** Stats class, holds miscellaneous stats counters
443 /** Server Config class, holds configuration file data
445 ServerConfig* Config;
447 /** Snomask manager - handles routing of snomask messages
452 /** DNS class, provides resolver facilities to the core and modules
456 /** Timer manager class, triggers Timer timer events
458 TimerManager* Timers;
460 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
462 XLineManager* XLines;
464 /** User manager. Various methods and data associated with users.
468 /** Channel list, a hash_map containing all channels XXX move to channel manager class
472 /** List of the open ports
474 std::vector<ListenSocket*> ports;
476 /** Set to the current signal recieved
480 /** Protocol interface, overridden by server protocol modules
482 ProtocolInterface* PI;
484 /** Holds extensible for user nickforced
486 LocalIntExt NICKForced;
488 /** Holds extensible for user operquit
490 LocalStringExt OperQuit;
492 /** Manages the generation and transmission of ISUPPORT. */
493 ISupportManager ISupport;
495 /** Get the current time
496 * Because this only calls time() once every time around the mainloop,
497 * it is much faster than calling time() directly.
498 * @return The current time as an epoch value (time_t)
500 inline time_t Time() { return TIME.tv_sec; }
501 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
502 inline long Time_ns() { return TIME.tv_nsec; }
503 /** Update the current time. Don't call this unless you have reason to do so. */
506 /** Generate a random string with the given length
507 * @param length The length in bytes
508 * @param printable if false, the string will use characters 0-255; otherwise,
509 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
511 std::string GenRandomStr(int length, bool printable = true);
512 /** Generate a random integer.
513 * This is generally more secure than rand()
515 unsigned long GenRandomInt(unsigned long max);
517 /** Fill a buffer with random bits */
518 caller2<void, char*, size_t> GenRandom;
520 /** Bind all ports specified in the configuration file.
521 * @return The number of ports bound without error
523 int BindPorts(FailedPortList &failed_ports);
525 /** Binds a socket on an already open file descriptor
526 * @param sockfd A valid file descriptor of an open socket
527 * @param port The port number to bind to
528 * @param addr The address to bind to (IP only)
529 * @param dolisten Should this port be listened on?
530 * @return True if the port was bound successfully
532 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
534 /** Gets the GECOS (description) field of the given server.
535 * If the servername is not that of the local server, the name
536 * is passed to handling modules which will attempt to determine
537 * the GECOS that bleongs to the given servername.
538 * @param servername The servername to find the description of
539 * @return The description of this server, or of the local server
541 std::string GetServerDescription(const std::string& servername);
543 /** Find a user in the nick hash.
544 * If the user cant be found in the nick hash check the uuid hash
545 * @param nick The nickname to find
546 * @return A pointer to the user, or NULL if the user does not exist
548 User* FindNick(const std::string &nick);
550 /** Find a user in the nick hash.
551 * If the user cant be found in the nick hash check the uuid hash
552 * @param nick The nickname to find
553 * @return A pointer to the user, or NULL if the user does not exist
555 User* FindNick(const char* nick);
557 /** Find a user in the nick hash ONLY
559 User* FindNickOnly(const char* nick);
561 /** Find a user in the nick hash ONLY
563 User* FindNickOnly(const std::string &nick);
565 /** Find a channel in the channels hash
566 * @param chan The channel to find
567 * @return A pointer to the channel, or NULL if the channel does not exist
569 Channel* FindChan(const std::string &chan);
571 /** Find a channel in the channels hash
572 * @param chan The channel to find
573 * @return A pointer to the channel, or NULL if the channel does not exist
575 Channel* FindChan(const char* chan);
577 /** Check we aren't running as root, and exit if we are
578 * @return Depending on the configuration, this function may never return
582 /** Determine the right path for, and open, the logfile
583 * @param argv The argv passed to main() initially, used to calculate program path
584 * @param argc The argc passed to main() initially, used to calculate program path
585 * @return True if the log could be opened, false if otherwise
587 bool OpenLog(char** argv, int argc);
589 /** Return true if a channel name is valid
590 * @param chname A channel name to verify
591 * @return True if the name is valid
593 caller2<bool, const std::string&, size_t> IsChannel;
595 /** Return true if str looks like a server ID
596 * @param string to check against
598 static bool IsSID(const std::string& sid);
600 /** Rehash the local server
602 caller1<void, const std::string&> Rehash;
604 /** Handles incoming signals after being set
605 * @param signal the signal recieved
607 void SignalHandler(int signal);
609 /** Sets the signal recieved
610 * @param signal the signal recieved
612 static void SetSignal(int signal);
614 /** Causes the server to exit after unloading modules and
615 * closing all open file descriptors.
617 * @param status The exit code to give to the operating system
618 * (See the ExitStatus enum for valid values)
620 void Exit(int status);
622 /** Causes the server to exit immediately with exit code 0.
623 * The status code is required for signal handlers, and ignored.
625 static void QuickExit(int status);
627 /** Return a count of channels on the network
628 * @return The number of channels
632 /** Send an error notice to all local users, opered and unopered
633 * @param s The error string to send
635 void SendError(const std::string &s);
637 /** Return true if a nickname is valid
638 * @param n A nickname to verify
639 * @return True if the nick is valid
641 caller2<bool, const std::string&, size_t> IsNick;
643 /** Return true if an ident is valid
644 * @param An ident to verify
645 * @return True if the ident is valid
647 caller1<bool, const std::string&> IsIdent;
649 /** Add a dns Resolver class to this server's active set
650 * @param r The resolver to add
651 * @param cached If this value is true, then the cache will
652 * be searched for the DNS result, immediately. If the value is
653 * false, then a request will be sent to the nameserver, and the
654 * result will not be immediately available. You should usually
655 * use the boolean value which you passed to the Resolver
656 * constructor, which Resolver will set appropriately depending
657 * on if cached results are available and haven't expired. It is
658 * however safe to force this value to false, forcing a remote DNS
659 * lookup, but not an update of the cache.
660 * @return True if the operation completed successfully. Note that
661 * if this method returns true, you should not attempt to access
662 * the resolver class you pass it after this call, as depending upon
663 * the request given, the object may be deleted!
665 bool AddResolver(Resolver* r, bool cached);
667 /** Add a command to this server's command parser
668 * @param f A Command command handler object to add
669 * @throw ModuleException Will throw ModuleExcption if the command already exists
671 inline void AddCommand(Command *f)
673 Modules->AddService(*f);
676 /** Send a modechange.
677 * The parameters provided are identical to that sent to the
678 * handler for class cmd_mode.
679 * @param parameters The mode parameters
680 * @param user The user to send error messages to
682 void SendMode(const std::vector<std::string>& parameters, User *user);
684 /** Send a modechange and route it to the network.
685 * The parameters provided are identical to that sent to the
686 * handler for class cmd_mode.
687 * @param parameters The mode parameters
688 * @param user The user to send error messages to
690 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
692 /** Match two strings using pattern matching, optionally, with a map
693 * to check case against (may be NULL). If map is null, match will be case insensitive.
694 * @param str The literal string to match against
695 * @param mask The glob pattern to match against.
696 * @param map The character map to use when matching.
698 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
699 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
701 /** Match two strings using pattern matching, optionally, with a map
702 * to check case against (may be NULL). If map is null, match will be case insensitive.
703 * Supports CIDR patterns as well as globs.
704 * @param str The literal string to match against
705 * @param mask The glob or CIDR pattern to match against.
706 * @param map The character map to use when matching.
708 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
709 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
711 /** Return true if the given parameter is a valid nick!user\@host mask
712 * @param mask A nick!user\@host masak to match against
713 * @return True i the mask is valid
715 bool IsValidMask(const std::string &mask);
717 /** Strips all color codes from the given string
718 * @param sentence The string to strip from
720 static void StripColor(std::string &sentence);
722 /** Parses color codes from string values to actual color codes
723 * @param input The data to process
725 static void ProcessColors(file_cache& input);
727 /** Rehash the local server
731 /** Check if the given nickmask matches too many users, send errors to the given user
732 * @param nick A nickmask to match against
733 * @param user A user to send error text to
734 * @return True if the nick matches too many users
736 bool NickMatchesEveryone(const std::string &nick, User* user);
738 /** Check if the given IP mask matches too many users, send errors to the given user
739 * @param ip An ipmask to match against
740 * @param user A user to send error text to
741 * @return True if the ip matches too many users
743 bool IPMatchesEveryone(const std::string &ip, User* user);
745 /** Check if the given hostmask matches too many users, send errors to the given user
746 * @param mask A hostmask to match against
747 * @param user A user to send error text to
748 * @return True if the host matches too many users
750 bool HostMatchesEveryone(const std::string &mask, User* user);
752 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
753 * @param str A string containing a time in the form 1y2w3d4h6m5s
754 * (one year, two weeks, three days, four hours, six minutes and five seconds)
755 * @return The total number of seconds
757 static unsigned long Duration(const std::string& str);
759 /** Attempt to compare a password to a string from the config file.
760 * This will be passed to handling modules which will compare the data
761 * against possible hashed equivalents in the input string.
762 * @param ex The object (user, server, whatever) causing the comparison.
763 * @param data The data from the config file
764 * @param input The data input by the oper
765 * @param hashtype The hash from the config file
766 * @return 0 if the strings match, 1 or -1 if they do not
768 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
770 /** Check if a given server is a uline.
771 * An empty string returns true, this is by design.
772 * @param server The server to check for uline status
773 * @return True if the server is a uline OR the string is empty
775 bool ULine(const std::string& server);
777 /** Returns true if the uline is 'silent' (doesnt generate
778 * remote connect notices etc).
780 bool SilentULine(const std::string& server);
782 /** Returns the full version string of this ircd
783 * @return The version string
785 std::string GetVersionString(bool rawversion = false);
787 /** Attempt to write the process id to a given file
788 * @param filename The PID file to attempt to write to
789 * @return This function may bail if the file cannot be written
791 void WritePID(const std::string &filename);
793 /** This constructor initialises all the subsystems and reads the config file.
794 * @param argc The argument count passed to main()
795 * @param argv The argument list passed to main()
796 * @throw <anything> If anything is thrown from here and makes it to
797 * you, you should probably just give up and go home. Yes, really.
798 * It's that bad. Higher level classes should catch any non-fatal exceptions.
800 InspIRCd(int argc, char** argv);
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 text Text of the numeric
808 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
810 /** Send a line of WHOIS data to a user.
811 * @param user user to send the line to
812 * @param dest user being WHOISed
813 * @param numeric Numeric to send
814 * @param format Format string for the numeric
815 * @param ... Parameters for the format string
817 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
819 /** Called to check whether a channel restriction mode applies to a user
820 * @param User that is attempting some action
821 * @param Channel that the action is being performed on
824 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
826 /** Restart the server.
827 * This function will not return. If an error occurs,
828 * it will throw an instance of CoreException.
829 * @param reason The restart reason to show to all clients
830 * @throw CoreException An instance of CoreException indicating the error from execv().
832 void Restart(const std::string &reason);
834 /** Prepare the ircd for restart or shutdown.
835 * This function unloads all modules which can be unloaded,
836 * closes all open sockets, and closes the logfile.
840 /** Return a time_t as a human-readable string.
842 std::string TimeString(time_t curtime);
844 /** Begin execution of the server.
845 * NOTE: this function NEVER returns. Internally,
846 * it will repeatedly loop.
847 * @return The return value for this function is undefined.
851 char* GetReadBuffer()
853 return this->ReadBuffer;
856 friend class TestSuite;
862 class CommandModule : public Module
866 CommandModule() : cmd(this)
872 ServerInstance->Modules->AddService(cmd);
877 return Version(cmd.name, VF_VENDOR|VF_CORE);