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;
53 #include "consolecolors.h"
55 #include "cull_list.h"
56 #include "extensible.h"
57 #include "fileutils.h"
65 #include "usermanager.h"
68 #include "command_parse.h"
70 #include "socketengine.h"
72 #include "filelogger.h"
74 #include "threadengine.h"
75 #include "configreader.h"
76 #include "inspstring.h"
79 /** Returned by some functions to indicate failure.
83 /** Template function to convert any input type to std::string
85 template<typename T> inline std::string ConvNumeric(const T &in)
93 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
98 std::reverse(out.begin(), out.end());
102 /** Template function to convert any input type to std::string
104 inline std::string ConvToStr(const int in)
106 return ConvNumeric(in);
109 /** Template function to convert any input type to std::string
111 inline std::string ConvToStr(const long in)
113 return ConvNumeric(in);
116 /** Template function to convert any input type to std::string
118 inline std::string ConvToStr(const char* in)
123 /** Template function to convert any input type to std::string
125 inline std::string ConvToStr(const bool in)
127 return (in ? "1" : "0");
130 /** Template function to convert any input type to std::string
132 inline std::string ConvToStr(char in)
134 return std::string(in,1);
137 /** Template function to convert any input type to std::string
139 template <class T> inline std::string ConvToStr(const T &in)
141 std::stringstream tmp;
142 if (!(tmp << in)) return std::string();
146 /** Template function to convert any input type to any other type
147 * (usually an integer or numeric type)
149 template<typename T> inline long ConvToInt(const T &in)
151 std::stringstream tmp;
152 if (!(tmp << in)) return 0;
153 return atol(tmp.str().c_str());
156 /** This class contains various STATS counters
157 * It is used by the InspIRCd class, which internally
158 * has an instance of it.
163 /** Number of accepted connections
165 unsigned long statsAccept;
166 /** Number of failed accepts
168 unsigned long statsRefused;
169 /** Number of unknown commands seen
171 unsigned long statsUnknown;
172 /** Number of nickname collisions handled
174 unsigned long statsCollisions;
175 /** Number of DNS queries sent out
177 unsigned long statsDns;
178 /** Number of good DNS replies received
179 * NOTE: This may not tally to the number sent out,
180 * due to timeouts and other latency issues.
182 unsigned long statsDnsGood;
183 /** Number of bad (negative) DNS replies received
184 * NOTE: This may not tally to the number sent out,
185 * due to timeouts and other latency issues.
187 unsigned long statsDnsBad;
188 /** Number of inbound connections seen
190 unsigned long statsConnects;
191 /** Total bytes of data transmitted
193 unsigned long statsSent;
194 /** Total bytes of data received
196 unsigned long statsRecv;
198 /** Cpu usage at last sample
201 /** Time QP sample was read
203 LARGE_INTEGER LastSampled;
206 LARGE_INTEGER QPFrequency;
208 /** Cpu usage at last sample
211 /** Time last sample was read
213 timespec LastSampled;
215 /** The constructor initializes all the counts to zero
218 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
219 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
224 /** This class manages the generation and transmission of ISUPPORT. */
225 class CoreExport ISupportManager
228 /** The generated lines which are sent to clients. */
229 std::vector<std::string> Lines;
232 /** (Re)build the ISUPPORT vector. */
235 /** Returns the std::vector of ISUPPORT lines. */
236 const std::vector<std::string>& GetLines()
241 /** Send the 005 numerics (ISUPPORT) to a user. */
242 void SendTo(LocalUser* user);
245 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
246 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
247 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
248 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
249 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
251 /** The main class of the irc server.
252 * This class contains instances of all the other classes in this software.
253 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
254 * object, and a list of active Module objects, and facilities for Module
255 * objects to interact with the core system it implements.
257 class CoreExport InspIRCd
260 /** Set up the signal handlers
264 /** Daemonize the ircd and close standard input/output streams
265 * @return True if the program daemonized succesfully
269 /** The current time, updated in the mainloop
271 struct timespec TIME;
273 /** A 64k buffer used to read socket data into
274 * NOTE: update ValidateNetBufferSize if you change this
276 char ReadBuffer[65535];
278 /** Check we aren't running as root, and exit if we are
279 * with exit code EXIT_STATUS_ROOT.
287 /** Global cull list, will be processed on next iteration
289 CullList GlobalCulls;
290 /** Actions that must happen outside of the current call stack */
291 ActionList AtomicActions;
295 IsNickHandler HandleIsNick;
296 IsIdentHandler HandleIsIdent;
297 OnCheckExemptionHandler HandleOnCheckExemption;
298 IsChannelHandler HandleIsChannel;
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 StringExtItem 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 /** Return true if a channel name is valid
475 * @param chname A channel name to verify
476 * @return True if the name is valid
478 caller1<bool, const std::string&> IsChannel;
480 /** Return true if str looks like a server ID
481 * @param sid string to check against
483 static bool IsSID(const std::string& sid);
485 /** Handles incoming signals after being set
486 * @param signal the signal recieved
488 void SignalHandler(int signal);
490 /** Sets the signal recieved
491 * @param signal the signal recieved
493 static void SetSignal(int signal);
495 /** Causes the server to exit after unloading modules and
496 * closing all open file descriptors.
498 * @param status The exit code to give to the operating system
499 * (See the ExitStatus enum for valid values)
501 void Exit(int status);
503 /** Causes the server to exit immediately with exit code 0.
504 * The status code is required for signal handlers, and ignored.
506 static void QuickExit(int status);
508 /** Formats the input string with the specified arguments.
509 * @param formatString The string to format
510 * @param ... A variable number of format arguments.
511 * @return The formatted string
513 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
514 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
516 /** Return a count of channels on the network
517 * @return The number of channels
519 long ChannelCount() const { return chanlist->size(); }
521 /** Send an error notice to all local users, opered and unopered
522 * @param s The error string to send
524 void SendError(const std::string &s);
526 /** Return true if a nickname is valid
527 * @param n A nickname to verify
528 * @return True if the nick is valid
530 caller1<bool, const std::string&> IsNick;
532 /** Return true if an ident is valid
533 * @param An ident to verify
534 * @return True if the ident is valid
536 caller1<bool, const std::string&> IsIdent;
538 /** Match two strings using pattern matching, optionally, with a map
539 * to check case against (may be NULL). If map is null, match will be case insensitive.
540 * @param str The literal string to match against
541 * @param mask The glob pattern to match against.
542 * @param map The character map to use when matching.
544 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
545 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
547 /** Match two strings using pattern matching, optionally, with a map
548 * to check case against (may be NULL). If map is null, match will be case insensitive.
549 * Supports CIDR patterns as well as globs.
550 * @param str The literal string to match against
551 * @param mask The glob or CIDR pattern to match against.
552 * @param map The character map to use when matching.
554 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
555 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
557 /** Matches a hostname and IP against a space delimited list of hostmasks.
558 * @param masks The space delimited masks to match against.
559 * @param hostname The hostname to try and match.
560 * @param ipaddr The IP address to try and match.
562 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
564 /** Return true if the given parameter is a valid nick!user\@host mask
565 * @param mask A nick!user\@host masak to match against
566 * @return True i the mask is valid
568 static bool IsValidMask(const std::string& mask);
570 /** Strips all color codes from the given string
571 * @param sentence The string to strip from
573 static void StripColor(std::string &sentence);
575 /** Parses color codes from string values to actual color codes
576 * @param input The data to process
578 static void ProcessColors(file_cache& input);
580 /** Rehash the local server
581 * @param uuid The uuid of the user who started the rehash, can be empty
583 void Rehash(const std::string& uuid = "");
585 /** Check if the given nickmask matches too many users, send errors to the given user
586 * @param nick A nickmask to match against
587 * @param user A user to send error text to
588 * @return True if the nick matches too many users
590 bool NickMatchesEveryone(const std::string &nick, User* user);
592 /** Check if the given IP mask matches too many users, send errors to the given user
593 * @param ip An ipmask to match against
594 * @param user A user to send error text to
595 * @return True if the ip matches too many users
597 bool IPMatchesEveryone(const std::string &ip, User* user);
599 /** Check if the given hostmask matches too many users, send errors to the given user
600 * @param mask A hostmask to match against
601 * @param user A user to send error text to
602 * @return True if the host matches too many users
604 bool HostMatchesEveryone(const std::string &mask, User* user);
606 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
607 * @param str A string containing a time in the form 1y2w3d4h6m5s
608 * (one year, two weeks, three days, four hours, six minutes and five seconds)
609 * @return The total number of seconds
611 static unsigned long Duration(const std::string& str);
613 /** Attempt to compare a password to a string from the config file.
614 * This will be passed to handling modules which will compare the data
615 * against possible hashed equivalents in the input string.
616 * @param ex The object (user, server, whatever) causing the comparison.
617 * @param data The data from the config file
618 * @param input The data input by the oper
619 * @param hashtype The hash from the config file
620 * @return 0 if the strings match, 1 or -1 if they do not
622 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
624 /** Check if a given server is a uline.
625 * An empty string returns true, this is by design.
626 * @param server The server to check for uline status
627 * @return True if the server is a uline OR the string is empty
629 bool ULine(const std::string& server);
631 /** Returns true if the uline is 'silent' (doesnt generate
632 * remote connect notices etc).
634 bool SilentULine(const std::string& server);
636 /** Returns the full version string of this ircd
637 * @return The version string
639 std::string GetVersionString(bool getFullVersion = false);
641 /** Attempt to write the process id to a given file
642 * @param filename The PID file to attempt to write to
643 * @return This function may bail if the file cannot be written
645 void WritePID(const std::string &filename);
647 /** This constructor initialises all the subsystems and reads the config file.
648 * @param argc The argument count passed to main()
649 * @param argv The argument list passed to main()
650 * @throw <anything> If anything is thrown from here and makes it to
651 * you, you should probably just give up and go home. Yes, really.
652 * It's that bad. Higher level classes should catch any non-fatal exceptions.
654 InspIRCd(int argc, char** argv);
656 /** Send a line of WHOIS data to a user.
657 * @param user user to send the line to
658 * @param dest user being WHOISed
659 * @param numeric Numeric to send
660 * @param text Text of the numeric
662 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
664 /** Send a line of WHOIS data to a user.
665 * @param user user to send the line to
666 * @param dest user being WHOISed
667 * @param numeric Numeric to send
668 * @param format Format string for the numeric
669 * @param ... Parameters for the format string
671 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
673 /** Called to check whether a channel restriction mode applies to a user
674 * @param User that is attempting some action
675 * @param Channel that the action is being performed on
678 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
680 /** Prepare the ircd for restart or shutdown.
681 * This function unloads all modules which can be unloaded,
682 * closes all open sockets, and closes the logfile.
686 /** Return a time_t as a human-readable string.
688 static std::string TimeString(time_t curtime);
690 /** Begin execution of the server.
691 * NOTE: this function NEVER returns. Internally,
692 * it will repeatedly loop.
696 char* GetReadBuffer()
698 return this->ReadBuffer;
705 class CommandModule : public Module
709 CommandModule() : cmd(this)
715 return Version(cmd.name, VF_VENDOR|VF_CORE);