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>
84 #include "inspircd_config.h"
85 #include "inspircd_version.h"
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 DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
272 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
273 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
274 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
275 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
276 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
280 /** The main class of the irc server.
281 * This class contains instances of all the other classes in this software.
282 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
283 * object, and a list of active Module objects, and facilities for Module
284 * objects to interact with the core system it implements.
286 class CoreExport InspIRCd
289 /** Holds the current UID. Used to generate the next one.
291 char current_uid[UUID_LENGTH];
293 /** Set up the signal handlers
297 /** Daemonize the ircd and close standard input/output streams
298 * @return True if the program daemonized succesfully
302 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
303 * @param TIME the current time
305 void DoSocketTimeouts(time_t TIME);
307 /** Increments the current UID by one.
309 void IncrementUID(int pos);
311 /** Perform background user events such as PING checks
313 void DoBackgroundUserStuff();
315 /** Returns true when all modules have done pre-registration checks on a user
316 * @param user The user to verify
317 * @return True if all modules have finished checking this user
319 bool AllModulesReportReady(LocalUser* user);
321 /** The current time, updated in the mainloop
323 struct timespec TIME;
325 /** A 64k buffer used to read socket data into
326 * NOTE: update ValidateNetBufferSize if you change this
328 char ReadBuffer[65535];
332 /** Global cull list, will be processed on next iteration
334 CullList GlobalCulls;
335 /** Actions that must happen outside of the current call stack */
336 ActionList AtomicActions;
340 IsNickHandler HandleIsNick;
341 IsIdentHandler HandleIsIdent;
342 OnCheckExemptionHandler HandleOnCheckExemption;
343 IsChannelHandler HandleIsChannel;
344 RehashHandler HandleRehash;
345 GenRandomHandler HandleGenRandom;
347 /** 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
350 * SendMode expects a User* to send the numeric replies
351 * back to, so we create it a fake user that isnt in the user
352 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
353 * falls into the abyss :p
355 FakeUser* FakeClient;
357 /** Returns the next available UID for this server.
359 std::string GetUID();
361 static const char LogHeader[];
363 /** Find a user in the UUID hash
364 * @param uid The UUID to find
365 * @return A pointer to the user, or NULL if the user does not exist
367 User* FindUUID(const std::string &uid);
369 /** Find a user in the UUID hash
370 * @param uid The UUID to find
371 * @return A pointer to the user, or NULL if the user does not exist
373 User* FindUUID(const char *uid);
375 /** Build the ISUPPORT string by triggering all modules On005Numeric events
377 void BuildISupport();
379 /** Time this ircd was booted
383 /** Config file pathname specified on the commandline or via ./configure
385 std::string ConfigFileName;
387 ExtensionManager Extensions;
389 /** Mode handler, handles mode setting and removal
393 /** Command parser, handles client to server commands
395 CommandParser* Parser;
397 /** Socket engine, handles socket activity events
401 /** Thread engine, Handles threading where required
403 ThreadEngine* Threads;
405 /** The thread/class used to read config files in REHASH and on startup
407 ConfigReaderThread* ConfigThread;
409 /** LogManager handles logging.
413 /** ModuleManager contains everything related to loading/unloading
416 ModuleManager* Modules;
418 /** BanCacheManager is used to speed up checking of restrictions on connection
421 BanCacheManager *BanCache;
423 /** Stats class, holds miscellaneous stats counters
427 /** Server Config class, holds configuration file data
429 ServerConfig* Config;
431 /** Snomask manager - handles routing of snomask messages
436 /** DNS class, provides resolver facilities to the core and modules
440 /** Timer manager class, triggers Timer timer events
442 TimerManager* Timers;
444 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
446 XLineManager* XLines;
448 /** User manager. Various methods and data associated with users.
452 /** Channel list, a hash_map containing all channels XXX move to channel manager class
456 /** List of the open ports
458 std::vector<ListenSocket*> ports;
460 /** Set to the current signal recieved
464 /** Protocol interface, overridden by server protocol modules
466 ProtocolInterface* PI;
468 /** Holds extensible for user nickforced
470 LocalIntExt NICKForced;
472 /** Holds extensible for user operquit
474 LocalStringExt OperQuit;
476 /** Get the current time
477 * Because this only calls time() once every time around the mainloop,
478 * it is much faster than calling time() directly.
479 * @return The current time as an epoch value (time_t)
481 inline time_t Time() { return TIME.tv_sec; }
482 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
483 inline long Time_ns() { return TIME.tv_nsec; }
484 /** Update the current time. Don't call this unless you have reason to do so. */
487 /** Generate a random string with the given length
488 * @param length The length in bytes
489 * @param printable if false, the string will use characters 0-255; otherwise,
490 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
492 std::string GenRandomStr(int length, bool printable = true);
493 /** Generate a random integer.
494 * This is generally more secure than rand()
496 unsigned long GenRandomInt(unsigned long max);
498 /** Fill a buffer with random bits */
499 caller2<void, char*, size_t> GenRandom;
501 /** Bind all ports specified in the configuration file.
502 * @return The number of ports bound without error
504 int BindPorts(FailedPortList &failed_ports);
506 /** Binds a socket on an already open file descriptor
507 * @param sockfd A valid file descriptor of an open socket
508 * @param port The port number to bind to
509 * @param addr The address to bind to (IP only)
510 * @param dolisten Should this port be listened on?
511 * @return True if the port was bound successfully
513 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
515 /** Gets the GECOS (description) field of the given server.
516 * If the servername is not that of the local server, the name
517 * is passed to handling modules which will attempt to determine
518 * the GECOS that bleongs to the given servername.
519 * @param servername The servername to find the description of
520 * @return The description of this server, or of the local server
522 std::string GetServerDescription(const std::string& servername);
524 /** Find a user in the nick hash.
525 * If the user cant be found in the nick hash check the uuid hash
526 * @param nick The nickname to find
527 * @return A pointer to the user, or NULL if the user does not exist
529 User* FindNick(const std::string &nick);
531 /** Find a user in the nick hash.
532 * If the user cant be found in the nick hash check the uuid hash
533 * @param nick The nickname to find
534 * @return A pointer to the user, or NULL if the user does not exist
536 User* FindNick(const char* nick);
538 /** Find a user in the nick hash ONLY
540 User* FindNickOnly(const char* nick);
542 /** Find a user in the nick hash ONLY
544 User* FindNickOnly(const std::string &nick);
546 /** Find a channel in the channels hash
547 * @param chan The channel to find
548 * @return A pointer to the channel, or NULL if the channel does not exist
550 Channel* FindChan(const std::string &chan);
552 /** Find a channel in the channels hash
553 * @param chan The channel to find
554 * @return A pointer to the channel, or NULL if the channel does not exist
556 Channel* FindChan(const char* chan);
558 /** Check we aren't running as root, and exit if we are
559 * @return Depending on the configuration, this function may never return
563 /** Determine the right path for, and open, the logfile
564 * @param argv The argv passed to main() initially, used to calculate program path
565 * @param argc The argc passed to main() initially, used to calculate program path
566 * @return True if the log could be opened, false if otherwise
568 bool OpenLog(char** argv, int argc);
570 /** Return true if a channel name is valid
571 * @param chname A channel name to verify
572 * @return True if the name is valid
574 caller2<bool, const std::string&, size_t> IsChannel;
576 /** Return true if str looks like a server ID
577 * @param string to check against
579 static bool IsSID(const std::string& sid);
581 /** Rehash the local server
583 caller1<void, const std::string&> Rehash;
585 /** Handles incoming signals after being set
586 * @param signal the signal recieved
588 void SignalHandler(int signal);
590 /** Sets the signal recieved
591 * @param signal the signal recieved
593 static void SetSignal(int signal);
595 /** Causes the server to exit after unloading modules and
596 * closing all open file descriptors.
598 * @param status The exit code to give to the operating system
599 * (See the ExitStatus enum for valid values)
601 void Exit(int status);
603 /** Causes the server to exit immediately with exit code 0.
604 * The status code is required for signal handlers, and ignored.
606 static void QuickExit(int status);
608 /** Return a count of channels on the network
609 * @return The number of channels
613 /** Send an error notice to all local users, opered and unopered
614 * @param s The error string to send
616 void SendError(const std::string &s);
618 /** Return true if a nickname is valid
619 * @param n A nickname to verify
620 * @return True if the nick is valid
622 caller2<bool, const std::string&, size_t> IsNick;
624 /** Return true if an ident is valid
625 * @param An ident to verify
626 * @return True if the ident is valid
628 caller1<bool, const std::string&> IsIdent;
630 /** Add a dns Resolver class to this server's active set
631 * @param r The resolver to add
632 * @param cached If this value is true, then the cache will
633 * be searched for the DNS result, immediately. If the value is
634 * false, then a request will be sent to the nameserver, and the
635 * result will not be immediately available. You should usually
636 * use the boolean value which you passed to the Resolver
637 * constructor, which Resolver will set appropriately depending
638 * on if cached results are available and haven't expired. It is
639 * however safe to force this value to false, forcing a remote DNS
640 * lookup, but not an update of the cache.
641 * @return True if the operation completed successfully. Note that
642 * if this method returns true, you should not attempt to access
643 * the resolver class you pass it after this call, as depending upon
644 * the request given, the object may be deleted!
646 bool AddResolver(Resolver* r, bool cached);
648 /** Add a command to this server's command parser
649 * @param f A Command command handler object to add
650 * @throw ModuleException Will throw ModuleExcption if the command already exists
652 inline void AddCommand(Command *f)
654 Modules->AddService(*f);
657 /** Send a modechange.
658 * The parameters provided are identical to that sent to the
659 * handler for class cmd_mode.
660 * @param parameters The mode parameters
661 * @param user The user to send error messages to
663 void SendMode(const std::vector<std::string>& parameters, User *user);
665 /** Send a modechange and route it to the network.
666 * The parameters provided are identical to that sent to the
667 * handler for class cmd_mode.
668 * @param parameters The mode parameters
669 * @param user The user to send error messages to
671 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
673 /** Match two strings using pattern matching, optionally, with a map
674 * to check case against (may be NULL). If map is null, match will be case insensitive.
675 * @param str The literal string to match against
676 * @param mask The glob pattern to match against.
677 * @param map The character map to use when matching.
679 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
680 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
682 /** Match two strings using pattern matching, optionally, with a map
683 * to check case against (may be NULL). If map is null, match will be case insensitive.
684 * Supports CIDR patterns as well as globs.
685 * @param str The literal string to match against
686 * @param mask The glob or CIDR pattern to match against.
687 * @param map The character map to use when matching.
689 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
690 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
692 /** Return true if the given parameter is a valid nick!user\@host mask
693 * @param mask A nick!user\@host masak to match against
694 * @return True i the mask is valid
696 bool IsValidMask(const std::string &mask);
698 /** Strips all color codes from the given string
699 * @param sentence The string to strip from
701 static void StripColor(std::string &sentence);
703 /** Parses color codes from string values to actual color codes
704 * @param input The data to process
706 static void ProcessColors(file_cache& input);
708 /** Rehash the local server
712 /** Check if the given nickmask matches too many users, send errors to the given user
713 * @param nick A nickmask to match against
714 * @param user A user to send error text to
715 * @return True if the nick matches too many users
717 bool NickMatchesEveryone(const std::string &nick, User* user);
719 /** Check if the given IP mask matches too many users, send errors to the given user
720 * @param ip An ipmask to match against
721 * @param user A user to send error text to
722 * @return True if the ip matches too many users
724 bool IPMatchesEveryone(const std::string &ip, User* user);
726 /** Check if the given hostmask matches too many users, send errors to the given user
727 * @param mask A hostmask to match against
728 * @param user A user to send error text to
729 * @return True if the host matches too many users
731 bool HostMatchesEveryone(const std::string &mask, User* user);
733 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
734 * @param str A string containing a time in the form 1y2w3d4h6m5s
735 * (one year, two weeks, three days, four hours, six minutes and five seconds)
736 * @return The total number of seconds
738 static unsigned long Duration(const std::string& str);
740 /** Attempt to compare a password to a string from the config file.
741 * This will be passed to handling modules which will compare the data
742 * against possible hashed equivalents in the input string.
743 * @param ex The object (user, server, whatever) causing the comparison.
744 * @param data The data from the config file
745 * @param input The data input by the oper
746 * @param hashtype The hash from the config file
747 * @return 0 if the strings match, 1 or -1 if they do not
749 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
751 /** Check if a given server is a uline.
752 * An empty string returns true, this is by design.
753 * @param server The server to check for uline status
754 * @return True if the server is a uline OR the string is empty
756 bool ULine(const std::string& server);
758 /** Returns true if the uline is 'silent' (doesnt generate
759 * remote connect notices etc).
761 bool SilentULine(const std::string& server);
763 /** Returns the full version string of this ircd
764 * @return The version string
766 std::string GetVersionString(bool rawversion = false);
768 /** Attempt to write the process id to a given file
769 * @param filename The PID file to attempt to write to
770 * @return This function may bail if the file cannot be written
772 void WritePID(const std::string &filename);
774 /** This constructor initialises all the subsystems and reads the config file.
775 * @param argc The argument count passed to main()
776 * @param argv The argument list passed to main()
777 * @throw <anything> If anything is thrown from here and makes it to
778 * you, you should probably just give up and go home. Yes, really.
779 * It's that bad. Higher level classes should catch any non-fatal exceptions.
781 InspIRCd(int argc, char** argv);
783 /** Send a line of WHOIS data to a user.
784 * @param user user to send the line to
785 * @param dest user being WHOISed
786 * @param numeric Numeric to send
787 * @param text Text of the numeric
789 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
791 /** Send a line of WHOIS data to a user.
792 * @param user user to send the line to
793 * @param dest user being WHOISed
794 * @param numeric Numeric to send
795 * @param format Format string for the numeric
796 * @param ... Parameters for the format string
798 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
802 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
804 /** Called to check whether a channel restriction mode applies to a user
805 * @param User that is attempting some action
806 * @param Channel that the action is being performed on
809 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
811 /** Restart the server.
812 * This function will not return. If an error occurs,
813 * it will throw an instance of CoreException.
814 * @param reason The restart reason to show to all clients
815 * @throw CoreException An instance of CoreException indicating the error from execv().
817 void Restart(const std::string &reason);
819 /** Prepare the ircd for restart or shutdown.
820 * This function unloads all modules which can be unloaded,
821 * closes all open sockets, and closes the logfile.
825 /** Resets the cached max bans value on all channels.
830 /** Return a time_t as a human-readable string.
832 std::string TimeString(time_t curtime);
834 /** Begin execution of the server.
835 * NOTE: this function NEVER returns. Internally,
836 * it will repeatedly loop.
837 * @return The return value for this function is undefined.
841 /** Adds an extban char to the 005 token.
843 void AddExtBanChar(char c);
845 char* GetReadBuffer()
847 return this->ReadBuffer;
850 friend class TestSuite;
856 class CommandModule : public Module
860 CommandModule() : cmd(this)
866 ServerInstance->Modules->AddService(cmd);
871 return Version(cmd.name, VF_VENDOR|VF_CORE);