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/>.
49 CoreExport extern InspIRCd* ServerInstance;
52 #include "consolecolors.h"
54 #include "cull_list.h"
55 #include "extensible.h"
63 #include "usermanager.h"
66 #include "command_parse.h"
68 #include "socketengine.h"
70 #include "filelogger.h"
72 #include "threadengine.h"
73 #include "configreader.h"
74 #include "inspstring.h"
77 /** Returned by some functions to indicate failure.
81 /** Template function to convert any input type to std::string
83 template<typename T> inline std::string ConvNumeric(const T &in)
91 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
96 std::reverse(out.begin(), out.end());
100 /** Template function to convert any input type to std::string
102 inline std::string ConvToStr(const int in)
104 return ConvNumeric(in);
107 /** Template function to convert any input type to std::string
109 inline std::string ConvToStr(const long in)
111 return ConvNumeric(in);
114 /** Template function to convert any input type to std::string
116 inline std::string ConvToStr(const char* in)
121 /** Template function to convert any input type to std::string
123 inline std::string ConvToStr(const bool in)
125 return (in ? "1" : "0");
128 /** Template function to convert any input type to std::string
130 inline std::string ConvToStr(char in)
132 return std::string(in,1);
135 /** Template function to convert any input type to std::string
137 template <class T> inline std::string ConvToStr(const T &in)
139 std::stringstream tmp;
140 if (!(tmp << in)) return std::string();
144 /** Template function to convert any input type to any other type
145 * (usually an integer or numeric type)
147 template<typename T> inline long ConvToInt(const T &in)
149 std::stringstream tmp;
150 if (!(tmp << in)) return 0;
151 return atol(tmp.str().c_str());
154 /** This class contains various STATS counters
155 * It is used by the InspIRCd class, which internally
156 * has an instance of it.
161 /** Number of accepted connections
163 unsigned long statsAccept;
164 /** Number of failed accepts
166 unsigned long statsRefused;
167 /** Number of unknown commands seen
169 unsigned long statsUnknown;
170 /** Number of nickname collisions handled
172 unsigned long statsCollisions;
173 /** Number of DNS queries sent out
175 unsigned long statsDns;
176 /** Number of good DNS replies received
177 * NOTE: This may not tally to the number sent out,
178 * due to timeouts and other latency issues.
180 unsigned long statsDnsGood;
181 /** Number of bad (negative) DNS replies received
182 * NOTE: This may not tally to the number sent out,
183 * due to timeouts and other latency issues.
185 unsigned long statsDnsBad;
186 /** Number of inbound connections seen
188 unsigned long statsConnects;
189 /** Total bytes of data transmitted
191 unsigned long statsSent;
192 /** Total bytes of data received
194 unsigned long statsRecv;
196 /** Cpu usage at last sample
199 /** Time QP sample was read
201 LARGE_INTEGER LastSampled;
204 LARGE_INTEGER QPFrequency;
206 /** Cpu usage at last sample
209 /** Time last sample was read
211 timespec LastSampled;
213 /** The constructor initializes all the counts to zero
216 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
217 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
222 /** This class manages the generation and transmission of ISUPPORT. */
223 class CoreExport ISupportManager
226 /** The generated lines which are sent to clients. */
227 std::vector<std::string> Lines;
230 /** (Re)build the ISUPPORT vector. */
233 /** Returns the std::vector of ISUPPORT lines. */
234 const std::vector<std::string>& GetLines()
239 /** Send the 005 numerics (ISUPPORT) to a user. */
240 void SendTo(LocalUser* user);
243 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
244 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
245 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
246 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
247 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
248 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
250 /** The main class of the irc server.
251 * This class contains instances of all the other classes in this software.
252 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
253 * object, and a list of active Module objects, and facilities for Module
254 * objects to interact with the core system it implements.
256 class CoreExport InspIRCd
259 /** Set up the signal handlers
263 /** Daemonize the ircd and close standard input/output streams
264 * @return True if the program daemonized succesfully
268 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
269 * @param TIME the current time
271 void DoSocketTimeouts(time_t TIME);
273 /** The current time, updated in the mainloop
275 struct timespec TIME;
277 /** A 64k buffer used to read socket data into
278 * NOTE: update ValidateNetBufferSize if you change this
280 char ReadBuffer[65535];
286 /** Global cull list, will be processed on next iteration
288 CullList GlobalCulls;
289 /** Actions that must happen outside of the current call stack */
290 ActionList AtomicActions;
294 IsNickHandler HandleIsNick;
295 IsIdentHandler HandleIsIdent;
296 OnCheckExemptionHandler HandleOnCheckExemption;
297 IsChannelHandler HandleIsChannel;
298 RehashHandler HandleRehash;
299 GenRandomHandler HandleGenRandom;
301 /** 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
304 * SendMode expects a User* to send the numeric replies
305 * back to, so we create it a fake user that isnt in the user
306 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
307 * falls into the abyss :p
309 FakeUser* FakeClient;
311 /** Find a user in the UUID hash
312 * @param uid The UUID to find
313 * @return A pointer to the user, or NULL if the user does not exist
315 User* FindUUID(const std::string &uid);
317 /** Time this ircd was booted
321 /** Config file pathname specified on the commandline or via ./configure
323 std::string ConfigFileName;
325 ExtensionManager Extensions;
327 /** Mode handler, handles mode setting and removal
331 /** Command parser, handles client to server commands
333 CommandParser* Parser;
335 /** Socket engine, handles socket activity events
339 /** Thread engine, Handles threading where required
341 ThreadEngine* Threads;
343 /** The thread/class used to read config files in REHASH and on startup
345 ConfigReaderThread* ConfigThread;
347 /** LogManager handles logging.
351 /** ModuleManager contains everything related to loading/unloading
354 ModuleManager* Modules;
356 /** BanCacheManager is used to speed up checking of restrictions on connection
359 BanCacheManager *BanCache;
361 /** Stats class, holds miscellaneous stats counters
365 /** Server Config class, holds configuration file data
367 ServerConfig* Config;
369 /** Snomask manager - handles routing of snomask messages
374 /** Timer manager class, triggers Timer timer events
376 TimerManager* Timers;
378 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
380 XLineManager* XLines;
382 /** User manager. Various methods and data associated with users.
386 /** Channel list, a hash_map containing all channels XXX move to channel manager class
390 /** List of the open ports
392 std::vector<ListenSocket*> ports;
394 /** Set to the current signal recieved
396 static sig_atomic_t s_signal;
398 /** Protocol interface, overridden by server protocol modules
400 ProtocolInterface* PI;
402 /** Holds extensible for user operquit
404 LocalStringExt OperQuit;
406 /** Manages the generation and transmission of ISUPPORT. */
407 ISupportManager ISupport;
409 /** Get the current time
410 * Because this only calls time() once every time around the mainloop,
411 * it is much faster than calling time() directly.
412 * @return The current time as an epoch value (time_t)
414 inline time_t Time() { return TIME.tv_sec; }
415 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
416 inline long Time_ns() { return TIME.tv_nsec; }
417 /** Update the current time. Don't call this unless you have reason to do so. */
420 /** Generate a random string with the given length
421 * @param length The length in bytes
422 * @param printable if false, the string will use characters 0-255; otherwise,
423 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
425 std::string GenRandomStr(int length, bool printable = true);
426 /** Generate a random integer.
427 * This is generally more secure than rand()
429 unsigned long GenRandomInt(unsigned long max);
431 /** Fill a buffer with random bits */
432 caller2<void, char*, size_t> GenRandom;
434 /** Bind all ports specified in the configuration file.
435 * @return The number of ports bound without error
437 int BindPorts(FailedPortList &failed_ports);
439 /** Binds a socket on an already open file descriptor
440 * @param sockfd A valid file descriptor of an open socket
441 * @param port The port number to bind to
442 * @param addr The address to bind to (IP only)
443 * @param dolisten Should this port be listened on?
444 * @return True if the port was bound successfully
446 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
448 /** Gets the GECOS (description) field of the given server.
449 * If the servername is not that of the local server, the name
450 * is passed to handling modules which will attempt to determine
451 * the GECOS that bleongs to the given servername.
452 * @param servername The servername to find the description of
453 * @return The description of this server, or of the local server
455 std::string GetServerDescription(const std::string& servername);
457 /** Find a user in the nick hash.
458 * If the user cant be found in the nick hash check the uuid hash
459 * @param nick The nickname to find
460 * @return A pointer to the user, or NULL if the user does not exist
462 User* FindNick(const std::string &nick);
464 /** Find a user in the nick hash ONLY
466 User* FindNickOnly(const std::string &nick);
468 /** Find a channel in the channels hash
469 * @param chan The channel to find
470 * @return A pointer to the channel, or NULL if the channel does not exist
472 Channel* FindChan(const std::string &chan);
474 /** Check we aren't running as root, and exit if we are
475 * @return Depending on the configuration, this function may never return
479 /** Return true if a channel name is valid
480 * @param chname A channel name to verify
481 * @return True if the name is valid
483 caller1<bool, const std::string&> IsChannel;
485 /** Return true if str looks like a server ID
486 * @param string to check against
488 static bool IsSID(const std::string& sid);
490 /** Rehash the local server
492 caller1<void, const std::string&> Rehash;
494 /** Handles incoming signals after being set
495 * @param signal the signal recieved
497 void SignalHandler(int signal);
499 /** Sets the signal recieved
500 * @param signal the signal recieved
502 static void SetSignal(int signal);
504 /** Causes the server to exit after unloading modules and
505 * closing all open file descriptors.
507 * @param status The exit code to give to the operating system
508 * (See the ExitStatus enum for valid values)
510 void Exit(int status);
512 /** Causes the server to exit immediately with exit code 0.
513 * The status code is required for signal handlers, and ignored.
517 * @param How you want it formatted
519 * @return The formatted string
521 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
522 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
524 static void QuickExit(int status);
526 /** Return a count of channels on the network
527 * @return The number of channels
529 long ChannelCount() const { return chanlist->size(); }
531 /** Send an error notice to all local users, opered and unopered
532 * @param s The error string to send
534 void SendError(const std::string &s);
536 /** Return true if a nickname is valid
537 * @param n A nickname to verify
538 * @return True if the nick is valid
540 caller1<bool, const std::string&> IsNick;
542 /** Return true if an ident is valid
543 * @param An ident to verify
544 * @return True if the ident is valid
546 caller1<bool, const std::string&> IsIdent;
548 /** Add a command to this server's command parser
549 * @param f A Command command handler object to add
550 * @throw ModuleException Will throw ModuleExcption if the command already exists
552 inline void AddCommand(Command *f)
554 Modules->AddService(*f);
557 /** Send a modechange.
558 * The parameters provided are identical to that sent to the
559 * handler for class cmd_mode.
560 * @param parameters The mode parameters
561 * @param user The user to send error messages to
563 void SendMode(const std::vector<std::string>& parameters, User *user);
565 /** Send a modechange and route it to the network.
566 * The parameters provided are identical to that sent to the
567 * handler for class cmd_mode.
568 * @param parameters The mode parameters
569 * @param user The user to send error messages to
571 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
573 /** Match two strings using pattern matching, optionally, with a map
574 * to check case against (may be NULL). If map is null, match will be case insensitive.
575 * @param str The literal string to match against
576 * @param mask The glob pattern to match against.
577 * @param map The character map to use when matching.
579 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
580 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
582 /** Match two strings using pattern matching, optionally, with a map
583 * to check case against (may be NULL). If map is null, match will be case insensitive.
584 * Supports CIDR patterns as well as globs.
585 * @param str The literal string to match against
586 * @param mask The glob or CIDR pattern to match against.
587 * @param map The character map to use when matching.
589 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
590 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
592 /** Matches a hostname and IP against a space delimited list of hostmasks.
593 * @param masks The space delimited masks to match against.
594 * @param hostname The hostname to try and match.
595 * @param ipaddr The IP address to try and match.
597 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
599 /** Return true if the given parameter is a valid nick!user\@host mask
600 * @param mask A nick!user\@host masak to match against
601 * @return True i the mask is valid
603 bool IsValidMask(const std::string &mask);
605 /** Strips all color codes from the given string
606 * @param sentence The string to strip from
608 static void StripColor(std::string &sentence);
610 /** Parses color codes from string values to actual color codes
611 * @param input The data to process
613 static void ProcessColors(file_cache& input);
615 /** Rehash the local server
619 /** Check if the given nickmask matches too many users, send errors to the given user
620 * @param nick A nickmask to match against
621 * @param user A user to send error text to
622 * @return True if the nick matches too many users
624 bool NickMatchesEveryone(const std::string &nick, User* user);
626 /** Check if the given IP mask matches too many users, send errors to the given user
627 * @param ip An ipmask to match against
628 * @param user A user to send error text to
629 * @return True if the ip matches too many users
631 bool IPMatchesEveryone(const std::string &ip, User* user);
633 /** Check if the given hostmask matches too many users, send errors to the given user
634 * @param mask A hostmask to match against
635 * @param user A user to send error text to
636 * @return True if the host matches too many users
638 bool HostMatchesEveryone(const std::string &mask, User* user);
640 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
641 * @param str A string containing a time in the form 1y2w3d4h6m5s
642 * (one year, two weeks, three days, four hours, six minutes and five seconds)
643 * @return The total number of seconds
645 static unsigned long Duration(const std::string& str);
647 /** Attempt to compare a password to a string from the config file.
648 * This will be passed to handling modules which will compare the data
649 * against possible hashed equivalents in the input string.
650 * @param ex The object (user, server, whatever) causing the comparison.
651 * @param data The data from the config file
652 * @param input The data input by the oper
653 * @param hashtype The hash from the config file
654 * @return 0 if the strings match, 1 or -1 if they do not
656 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
658 /** Check if a given server is a uline.
659 * An empty string returns true, this is by design.
660 * @param server The server to check for uline status
661 * @return True if the server is a uline OR the string is empty
663 bool ULine(const std::string& server);
665 /** Returns true if the uline is 'silent' (doesnt generate
666 * remote connect notices etc).
668 bool SilentULine(const std::string& server);
670 /** Returns the full version string of this ircd
671 * @return The version string
673 std::string GetVersionString(bool getFullVersion = false);
675 /** Attempt to write the process id to a given file
676 * @param filename The PID file to attempt to write to
677 * @return This function may bail if the file cannot be written
679 void WritePID(const std::string &filename);
681 /** This constructor initialises all the subsystems and reads the config file.
682 * @param argc The argument count passed to main()
683 * @param argv The argument list passed to main()
684 * @throw <anything> If anything is thrown from here and makes it to
685 * you, you should probably just give up and go home. Yes, really.
686 * It's that bad. Higher level classes should catch any non-fatal exceptions.
688 InspIRCd(int argc, char** argv);
690 /** Send a line of WHOIS data to a user.
691 * @param user user to send the line to
692 * @param dest user being WHOISed
693 * @param numeric Numeric to send
694 * @param text Text of the numeric
696 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
698 /** Send a line of WHOIS data to a user.
699 * @param user user to send the line to
700 * @param dest user being WHOISed
701 * @param numeric Numeric to send
702 * @param format Format string for the numeric
703 * @param ... Parameters for the format string
705 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
707 /** Called to check whether a channel restriction mode applies to a user
708 * @param User that is attempting some action
709 * @param Channel that the action is being performed on
712 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
714 /** Restart the server.
715 * This function will not return. If an error occurs,
716 * it will throw an instance of CoreException.
717 * @param reason The restart reason to show to all clients
718 * @throw CoreException An instance of CoreException indicating the error from execv().
720 void Restart(const std::string &reason);
722 /** Prepare the ircd for restart or shutdown.
723 * This function unloads all modules which can be unloaded,
724 * closes all open sockets, and closes the logfile.
728 /** Return a time_t as a human-readable string.
730 std::string TimeString(time_t curtime);
732 /** Begin execution of the server.
733 * NOTE: this function NEVER returns. Internally,
734 * it will repeatedly loop.
735 * @return The return value for this function is undefined.
739 char* GetReadBuffer()
741 return this->ReadBuffer;
748 class CommandModule : public Module
752 CommandModule() : cmd(this)
758 ServerInstance->Modules->AddService(cmd);
763 return Version(cmd.name, VF_VENDOR|VF_CORE);
767 inline void InspIRCd::SendMode(const std::vector<std::string>& parameters, User* user)
769 this->Modes->Process(parameters, user);