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"
64 #include "usermanager.h"
67 #include "command_parse.h"
69 #include "socketengine.h"
71 #include "filelogger.h"
73 #include "threadengine.h"
74 #include "configreader.h"
75 #include "inspstring.h"
78 /** Returned by some functions to indicate failure.
82 /** Template function to convert any input type to std::string
84 template<typename T> inline std::string ConvNumeric(const T &in)
92 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
97 std::reverse(out.begin(), out.end());
101 /** Template function to convert any input type to std::string
103 inline std::string ConvToStr(const int in)
105 return ConvNumeric(in);
108 /** Template function to convert any input type to std::string
110 inline std::string ConvToStr(const long in)
112 return ConvNumeric(in);
115 /** Template function to convert any input type to std::string
117 inline std::string ConvToStr(const char* in)
122 /** Template function to convert any input type to std::string
124 inline std::string ConvToStr(const bool in)
126 return (in ? "1" : "0");
129 /** Template function to convert any input type to std::string
131 inline std::string ConvToStr(char in)
133 return std::string(in,1);
136 /** Template function to convert any input type to std::string
138 template <class T> inline std::string ConvToStr(const T &in)
140 std::stringstream tmp;
141 if (!(tmp << in)) return std::string();
145 /** Template function to convert any input type to any other type
146 * (usually an integer or numeric type)
148 template<typename T> inline long ConvToInt(const T &in)
150 std::stringstream tmp;
151 if (!(tmp << in)) return 0;
152 return atol(tmp.str().c_str());
155 /** This class contains various STATS counters
156 * It is used by the InspIRCd class, which internally
157 * has an instance of it.
162 /** Number of accepted connections
164 unsigned long statsAccept;
165 /** Number of failed accepts
167 unsigned long statsRefused;
168 /** Number of unknown commands seen
170 unsigned long statsUnknown;
171 /** Number of nickname collisions handled
173 unsigned long statsCollisions;
174 /** Number of DNS queries sent out
176 unsigned long statsDns;
177 /** Number of good DNS replies received
178 * NOTE: This may not tally to the number sent out,
179 * due to timeouts and other latency issues.
181 unsigned long statsDnsGood;
182 /** Number of bad (negative) DNS replies received
183 * NOTE: This may not tally to the number sent out,
184 * due to timeouts and other latency issues.
186 unsigned long statsDnsBad;
187 /** Number of inbound connections seen
189 unsigned long statsConnects;
190 /** Total bytes of data transmitted
192 unsigned long statsSent;
193 /** Total bytes of data received
195 unsigned long statsRecv;
197 /** Cpu usage at last sample
200 /** Time QP sample was read
202 LARGE_INTEGER LastSampled;
205 LARGE_INTEGER QPFrequency;
207 /** Cpu usage at last sample
210 /** Time last sample was read
212 timespec LastSampled;
214 /** The constructor initializes all the counts to zero
217 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
218 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
223 /** This class manages the generation and transmission of ISUPPORT. */
224 class CoreExport ISupportManager
227 /** The generated lines which are sent to clients. */
228 std::vector<std::string> Lines;
231 /** (Re)build the ISUPPORT vector. */
234 /** Returns the std::vector of ISUPPORT lines. */
235 const std::vector<std::string>& GetLines()
240 /** Send the 005 numerics (ISUPPORT) to a user. */
241 void SendTo(LocalUser* user);
244 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
245 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
246 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
247 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
248 DEFINE_HANDLER1(RehashHandler, void, 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 RehashHandler HandleRehash;
300 GenRandomHandler HandleGenRandom;
302 /** 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
305 * SendMode expects a User* to send the numeric replies
306 * back to, so we create it a fake user that isnt in the user
307 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
308 * falls into the abyss :p
310 FakeUser* FakeClient;
312 /** Find a user in the UUID hash
313 * @param uid The UUID to find
314 * @return A pointer to the user, or NULL if the user does not exist
316 User* FindUUID(const std::string &uid);
318 /** Time this ircd was booted
322 /** Config file pathname specified on the commandline or via ./configure
324 std::string ConfigFileName;
326 ExtensionManager Extensions;
328 /** Mode handler, handles mode setting and removal
332 /** Command parser, handles client to server commands
334 CommandParser* Parser;
336 /** Socket engine, handles socket activity events
340 /** Thread engine, Handles threading where required
342 ThreadEngine* Threads;
344 /** The thread/class used to read config files in REHASH and on startup
346 ConfigReaderThread* ConfigThread;
348 /** LogManager handles logging.
352 /** ModuleManager contains everything related to loading/unloading
355 ModuleManager* Modules;
357 /** BanCacheManager is used to speed up checking of restrictions on connection
360 BanCacheManager *BanCache;
362 /** Stats class, holds miscellaneous stats counters
366 /** Server Config class, holds configuration file data
368 ServerConfig* Config;
370 /** Snomask manager - handles routing of snomask messages
375 /** Timer manager class, triggers Timer timer events
377 TimerManager* Timers;
379 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
381 XLineManager* XLines;
383 /** User manager. Various methods and data associated with users.
387 /** Channel list, a hash_map containing all channels XXX move to channel manager class
391 /** List of the open ports
393 std::vector<ListenSocket*> ports;
395 /** Set to the current signal recieved
397 static sig_atomic_t s_signal;
399 /** Protocol interface, overridden by server protocol modules
401 ProtocolInterface* PI;
403 /** Holds extensible for user operquit
405 LocalStringExt OperQuit;
407 /** Manages the generation and transmission of ISUPPORT. */
408 ISupportManager ISupport;
410 /** Get the current time
411 * Because this only calls time() once every time around the mainloop,
412 * it is much faster than calling time() directly.
413 * @return The current time as an epoch value (time_t)
415 inline time_t Time() { return TIME.tv_sec; }
416 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
417 inline long Time_ns() { return TIME.tv_nsec; }
418 /** Update the current time. Don't call this unless you have reason to do so. */
421 /** Generate a random string with the given length
422 * @param length The length in bytes
423 * @param printable if false, the string will use characters 0-255; otherwise,
424 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
426 std::string GenRandomStr(int length, bool printable = true);
427 /** Generate a random integer.
428 * This is generally more secure than rand()
430 unsigned long GenRandomInt(unsigned long max);
432 /** Fill a buffer with random bits */
433 caller2<void, char*, size_t> GenRandom;
435 /** Bind all ports specified in the configuration file.
436 * @return The number of ports bound without error
438 int BindPorts(FailedPortList &failed_ports);
440 /** Binds a socket on an already open file descriptor
441 * @param sockfd A valid file descriptor of an open socket
442 * @param port The port number to bind to
443 * @param addr The address to bind to (IP only)
444 * @param dolisten Should this port be listened on?
445 * @return True if the port was bound successfully
447 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
449 /** Gets the GECOS (description) field of the given server.
450 * If the servername is not that of the local server, the name
451 * is passed to handling modules which will attempt to determine
452 * the GECOS that bleongs to the given servername.
453 * @param servername The servername to find the description of
454 * @return The description of this server, or of the local server
456 std::string GetServerDescription(const std::string& servername);
458 /** Find a user in the nick hash.
459 * If the user cant be found in the nick hash check the uuid hash
460 * @param nick The nickname to find
461 * @return A pointer to the user, or NULL if the user does not exist
463 User* FindNick(const std::string &nick);
465 /** Find a user in the nick hash ONLY
467 User* FindNickOnly(const std::string &nick);
469 /** Find a channel in the channels hash
470 * @param chan The channel to find
471 * @return A pointer to the channel, or NULL if the channel does not exist
473 Channel* FindChan(const std::string &chan);
475 /** Return true if a channel name is valid
476 * @param chname A channel name to verify
477 * @return True if the name is valid
479 caller1<bool, const std::string&> IsChannel;
481 /** Return true if str looks like a server ID
482 * @param sid string to check against
484 static bool IsSID(const std::string& sid);
486 /** Rehash the local server
488 caller1<void, const std::string&> Rehash;
490 /** Handles incoming signals after being set
491 * @param signal the signal recieved
493 void SignalHandler(int signal);
495 /** Sets the signal recieved
496 * @param signal the signal recieved
498 static void SetSignal(int signal);
500 /** Causes the server to exit after unloading modules and
501 * closing all open file descriptors.
503 * @param status The exit code to give to the operating system
504 * (See the ExitStatus enum for valid values)
506 void Exit(int status);
508 /** Causes the server to exit immediately with exit code 0.
509 * The status code is required for signal handlers, and ignored.
511 static void QuickExit(int status);
513 /** Formats the input string with the specified arguments.
514 * @param formatString The string to format
515 * @param ... A variable number of format arguments.
516 * @return The formatted string
518 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
519 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
521 /** Return a count of channels on the network
522 * @return The number of channels
524 long ChannelCount() const { return chanlist->size(); }
526 /** Send an error notice to all local users, opered and unopered
527 * @param s The error string to send
529 void SendError(const std::string &s);
531 /** Return true if a nickname is valid
532 * @param n A nickname to verify
533 * @return True if the nick is valid
535 caller1<bool, const std::string&> IsNick;
537 /** Return true if an ident is valid
538 * @param An ident to verify
539 * @return True if the ident is valid
541 caller1<bool, const std::string&> IsIdent;
543 /** Match two strings using pattern matching, optionally, with a map
544 * to check case against (may be NULL). If map is null, match will be case insensitive.
545 * @param str The literal string to match against
546 * @param mask The glob pattern to match against.
547 * @param map The character map to use when matching.
549 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
550 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
552 /** Match two strings using pattern matching, optionally, with a map
553 * to check case against (may be NULL). If map is null, match will be case insensitive.
554 * Supports CIDR patterns as well as globs.
555 * @param str The literal string to match against
556 * @param mask The glob or CIDR pattern to match against.
557 * @param map The character map to use when matching.
559 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
560 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
562 /** Matches a hostname and IP against a space delimited list of hostmasks.
563 * @param masks The space delimited masks to match against.
564 * @param hostname The hostname to try and match.
565 * @param ipaddr The IP address to try and match.
567 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
569 /** Return true if the given parameter is a valid nick!user\@host mask
570 * @param mask A nick!user\@host masak to match against
571 * @return True i the mask is valid
573 bool IsValidMask(const std::string &mask);
575 /** Strips all color codes from the given string
576 * @param sentence The string to strip from
578 static void StripColor(std::string &sentence);
580 /** Parses color codes from string values to actual color codes
581 * @param input The data to process
583 static void ProcessColors(file_cache& input);
585 /** Rehash the local server
589 /** Check if the given nickmask matches too many users, send errors to the given user
590 * @param nick A nickmask to match against
591 * @param user A user to send error text to
592 * @return True if the nick matches too many users
594 bool NickMatchesEveryone(const std::string &nick, User* user);
596 /** Check if the given IP mask matches too many users, send errors to the given user
597 * @param ip An ipmask to match against
598 * @param user A user to send error text to
599 * @return True if the ip matches too many users
601 bool IPMatchesEveryone(const std::string &ip, User* user);
603 /** Check if the given hostmask matches too many users, send errors to the given user
604 * @param mask A hostmask to match against
605 * @param user A user to send error text to
606 * @return True if the host matches too many users
608 bool HostMatchesEveryone(const std::string &mask, User* user);
610 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
611 * @param str A string containing a time in the form 1y2w3d4h6m5s
612 * (one year, two weeks, three days, four hours, six minutes and five seconds)
613 * @return The total number of seconds
615 static unsigned long Duration(const std::string& str);
617 /** Attempt to compare a password to a string from the config file.
618 * This will be passed to handling modules which will compare the data
619 * against possible hashed equivalents in the input string.
620 * @param ex The object (user, server, whatever) causing the comparison.
621 * @param data The data from the config file
622 * @param input The data input by the oper
623 * @param hashtype The hash from the config file
624 * @return 0 if the strings match, 1 or -1 if they do not
626 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
628 /** Check if a given server is a uline.
629 * An empty string returns true, this is by design.
630 * @param server The server to check for uline status
631 * @return True if the server is a uline OR the string is empty
633 bool ULine(const std::string& server);
635 /** Returns true if the uline is 'silent' (doesnt generate
636 * remote connect notices etc).
638 bool SilentULine(const std::string& server);
640 /** Returns the full version string of this ircd
641 * @return The version string
643 std::string GetVersionString(bool getFullVersion = false);
645 /** Attempt to write the process id to a given file
646 * @param filename The PID file to attempt to write to
647 * @return This function may bail if the file cannot be written
649 void WritePID(const std::string &filename);
651 /** This constructor initialises all the subsystems and reads the config file.
652 * @param argc The argument count passed to main()
653 * @param argv The argument list passed to main()
654 * @throw <anything> If anything is thrown from here and makes it to
655 * you, you should probably just give up and go home. Yes, really.
656 * It's that bad. Higher level classes should catch any non-fatal exceptions.
658 InspIRCd(int argc, char** argv);
660 /** Send a line of WHOIS data to a user.
661 * @param user user to send the line to
662 * @param dest user being WHOISed
663 * @param numeric Numeric to send
664 * @param text Text of the numeric
666 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
668 /** Send a line of WHOIS data to a user.
669 * @param user user to send the line to
670 * @param dest user being WHOISed
671 * @param numeric Numeric to send
672 * @param format Format string for the numeric
673 * @param ... Parameters for the format string
675 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
677 /** Called to check whether a channel restriction mode applies to a user
678 * @param User that is attempting some action
679 * @param Channel that the action is being performed on
682 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
684 /** Prepare the ircd for restart or shutdown.
685 * This function unloads all modules which can be unloaded,
686 * closes all open sockets, and closes the logfile.
690 /** Return a time_t as a human-readable string.
692 std::string TimeString(time_t curtime);
694 /** Begin execution of the server.
695 * NOTE: this function NEVER returns. Internally,
696 * it will repeatedly loop.
700 char* GetReadBuffer()
702 return this->ReadBuffer;
709 class CommandModule : public Module
713 CommandModule() : cmd(this)
719 ServerInstance->Modules->AddService(cmd);
724 return Version(cmd.name, VF_VENDOR|VF_CORE);