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/>.
46 #include "intrusive_list.h"
51 CoreExport extern InspIRCd* ServerInstance;
53 /** Base class for manager classes that are still accessed using -> but are no longer pointers
60 return static_cast<T*>(this);
66 #include "consolecolors.h"
68 #include "cull_list.h"
69 #include "extensible.h"
70 #include "fileutils.h"
79 #include "usermanager.h"
82 #include "command_parse.h"
84 #include "socketengine.h"
86 #include "filelogger.h"
88 #include "threadengine.h"
89 #include "configreader.h"
90 #include "inspstring.h"
94 /** Template function to convert any input type to std::string
96 template<typename T> inline std::string ConvNumeric(const T &in)
104 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
109 std::reverse(out.begin(), out.end());
113 /** Template function to convert any input type to std::string
115 inline std::string ConvToStr(const int in)
117 return ConvNumeric(in);
120 /** Template function to convert any input type to std::string
122 inline std::string ConvToStr(const long in)
124 return ConvNumeric(in);
127 /** Template function to convert any input type to std::string
129 inline std::string ConvToStr(const char* in)
134 /** Template function to convert any input type to std::string
136 inline std::string ConvToStr(const bool in)
138 return (in ? "1" : "0");
141 /** Template function to convert any input type to std::string
143 inline std::string ConvToStr(char in)
145 return std::string(1, in);
148 /** Template function to convert any input type to std::string
150 template <class T> inline std::string ConvToStr(const T &in)
152 std::stringstream tmp;
153 if (!(tmp << in)) return std::string();
157 /** Template function to convert any input type to any other type
158 * (usually an integer or numeric type)
160 template<typename T> inline long ConvToInt(const T &in)
162 std::stringstream tmp;
163 if (!(tmp << in)) return 0;
164 return atol(tmp.str().c_str());
167 inline uint64_t ConvToUInt64(const std::string& in)
170 std::istringstream tmp(in);
176 /** This class contains various STATS counters
177 * It is used by the InspIRCd class, which internally
178 * has an instance of it.
183 /** Number of accepted connections
185 unsigned long Accept;
186 /** Number of failed accepts
188 unsigned long Refused;
189 /** Number of unknown commands seen
191 unsigned long Unknown;
192 /** Number of nickname collisions handled
194 unsigned long Collisions;
195 /** Number of DNS queries sent out
198 /** Number of good DNS replies received
199 * NOTE: This may not tally to the number sent out,
200 * due to timeouts and other latency issues.
202 unsigned long DnsGood;
203 /** Number of bad (negative) DNS replies received
204 * NOTE: This may not tally to the number sent out,
205 * due to timeouts and other latency issues.
207 unsigned long DnsBad;
208 /** Number of inbound connections seen
210 unsigned long Connects;
211 /** Total bytes of data transmitted
214 /** Total bytes of data received
218 /** Cpu usage at last sample
221 /** Time QP sample was read
223 LARGE_INTEGER LastSampled;
226 LARGE_INTEGER QPFrequency;
228 /** Cpu usage at last sample
231 /** Time last sample was read
233 timespec LastSampled;
235 /** The constructor initializes all the counts to zero
238 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
239 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
244 /** This class manages the generation and transmission of ISUPPORT. */
245 class CoreExport ISupportManager
248 /** The generated lines which are sent to clients. */
249 std::vector<std::string> Lines;
252 /** (Re)build the ISUPPORT vector. */
255 /** Returns the std::vector of ISUPPORT lines. */
256 const std::vector<std::string>& GetLines()
261 /** Send the 005 numerics (ISUPPORT) to a user. */
262 void SendTo(LocalUser* user);
265 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
266 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
267 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
268 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
269 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
271 /** The main class of the irc server.
272 * This class contains instances of all the other classes in this software.
273 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
274 * object, and a list of active Module objects, and facilities for Module
275 * objects to interact with the core system it implements.
277 class CoreExport InspIRCd
280 /** Set up the signal handlers
284 /** Daemonize the ircd and close standard input/output streams
285 * @return True if the program daemonized succesfully
289 /** The current time, updated in the mainloop
291 struct timespec TIME;
293 /** A 64k buffer used to read socket data into
294 * NOTE: update ValidateNetBufferSize if you change this
296 char ReadBuffer[65535];
298 /** Check we aren't running as root, and exit if we are
299 * with exit code EXIT_STATUS_ROOT.
307 /** Global cull list, will be processed on next iteration
309 CullList GlobalCulls;
310 /** Actions that must happen outside of the current call stack */
311 ActionList AtomicActions;
315 IsNickHandler HandleIsNick;
316 IsIdentHandler HandleIsIdent;
317 OnCheckExemptionHandler HandleOnCheckExemption;
318 IsChannelHandler HandleIsChannel;
319 GenRandomHandler HandleGenRandom;
321 /** 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
324 * SendMode expects a User* to send the numeric replies
325 * back to, so we create it a fake user that isnt in the user
326 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
327 * falls into the abyss :p
329 FakeUser* FakeClient;
331 /** Find a user in the UUID hash
332 * @param uid The UUID to find
333 * @return A pointer to the user, or NULL if the user does not exist
335 User* FindUUID(const std::string &uid);
337 /** Time this ircd was booted
341 /** Config file pathname specified on the commandline or via ./configure
343 std::string ConfigFileName;
345 ExtensionManager Extensions;
347 /** Mode handler, handles mode setting and removal
351 /** Command parser, handles client to server commands
353 CommandParser Parser;
355 /** Thread engine, Handles threading where required
357 ThreadEngine Threads;
359 /** The thread/class used to read config files in REHASH and on startup
361 ConfigReaderThread* ConfigThread;
363 /** LogManager handles logging.
367 /** ModuleManager contains everything related to loading/unloading
370 ModuleManager Modules;
372 /** BanCacheManager is used to speed up checking of restrictions on connection
375 BanCacheManager BanCache;
377 /** Stats class, holds miscellaneous stats counters
381 /** Server Config class, holds configuration file data
383 ServerConfig* Config;
385 /** Snomask manager - handles routing of snomask messages
390 /** Timer manager class, triggers Timer timer events
394 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
396 XLineManager* XLines;
398 /** User manager. Various methods and data associated with users.
402 /** Channel list, a hash_map containing all channels XXX move to channel manager class
406 /** List of the open ports
408 std::vector<ListenSocket*> ports;
410 /** Set to the current signal recieved
412 static sig_atomic_t s_signal;
414 /** Protocol interface, overridden by server protocol modules
416 ProtocolInterface* PI;
418 /** Default implementation of the ProtocolInterface, does nothing
420 ProtocolInterface DefaultProtocolInterface;
422 /** Holds extensible for user operquit
424 StringExtItem OperQuit;
426 /** Manages the generation and transmission of ISUPPORT. */
427 ISupportManager ISupport;
429 /** Get the current time
430 * Because this only calls time() once every time around the mainloop,
431 * it is much faster than calling time() directly.
432 * @return The current time as an epoch value (time_t)
434 inline time_t Time() { return TIME.tv_sec; }
435 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
436 inline long Time_ns() { return TIME.tv_nsec; }
437 /** Update the current time. Don't call this unless you have reason to do so. */
440 /** Generate a random string with the given length
441 * @param length The length in bytes
442 * @param printable if false, the string will use characters 0-255; otherwise,
443 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
445 std::string GenRandomStr(int length, bool printable = true);
446 /** Generate a random integer.
447 * This is generally more secure than rand()
449 unsigned long GenRandomInt(unsigned long max);
451 /** Fill a buffer with random bits */
452 caller2<void, char*, size_t> GenRandom;
454 /** Bind all ports specified in the configuration file.
455 * @return The number of ports bound without error
457 int BindPorts(FailedPortList &failed_ports);
459 /** Binds a socket on an already open file descriptor
460 * @param sockfd A valid file descriptor of an open socket
461 * @param port The port number to bind to
462 * @param addr The address to bind to (IP only)
463 * @param dolisten Should this port be listened on?
464 * @return True if the port was bound successfully
466 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
468 /** Find a user in the nick hash.
469 * If the user cant be found in the nick hash check the uuid hash
470 * @param nick The nickname to find
471 * @return A pointer to the user, or NULL if the user does not exist
473 User* FindNick(const std::string &nick);
475 /** Find a user in the nick hash ONLY
477 User* FindNickOnly(const std::string &nick);
479 /** Find a channel in the channels hash
480 * @param chan The channel to find
481 * @return A pointer to the channel, or NULL if the channel does not exist
483 Channel* FindChan(const std::string &chan);
485 /** Get a hash map containing all channels, keyed by their name
486 * @return A hash map mapping channel names to Channel pointers
488 chan_hash& GetChans() { return chanlist; }
490 /** Return true if a channel name is valid
491 * @param chname A channel name to verify
492 * @return True if the name is valid
494 caller1<bool, const std::string&> IsChannel;
496 /** Return true if str looks like a server ID
497 * @param sid string to check against
499 static bool IsSID(const std::string& sid);
501 /** Handles incoming signals after being set
502 * @param signal the signal recieved
504 void SignalHandler(int signal);
506 /** Sets the signal recieved
507 * @param signal the signal recieved
509 static void SetSignal(int signal);
511 /** Causes the server to exit after unloading modules and
512 * closing all open file descriptors.
514 * @param status The exit code to give to the operating system
515 * (See the ExitStatus enum for valid values)
517 void Exit(int status);
519 /** Causes the server to exit immediately with exit code 0.
520 * The status code is required for signal handlers, and ignored.
522 static void QuickExit(int status);
524 /** Formats the input string with the specified arguments.
525 * @param formatString The string to format
526 * @param ... A variable number of format arguments.
527 * @return The formatted string
529 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
530 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
532 /** Send an error notice to all local users, opered and unopered
533 * @param s The error string to send
535 void SendError(const std::string &s);
537 /** Return true if a nickname is valid
538 * @param n A nickname to verify
539 * @return True if the nick is valid
541 caller1<bool, const std::string&> IsNick;
543 /** Return true if an ident is valid
544 * @param An ident to verify
545 * @return True if the ident is valid
547 caller1<bool, const std::string&> IsIdent;
549 /** Match two strings using pattern matching, optionally, with a map
550 * to check case against (may be NULL). If map is null, match will be case insensitive.
551 * @param str The literal string to match against
552 * @param mask The glob pattern to match against.
553 * @param map The character map to use when matching.
555 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
556 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
558 /** Match two strings using pattern matching, optionally, with a map
559 * to check case against (may be NULL). If map is null, match will be case insensitive.
560 * Supports CIDR patterns as well as globs.
561 * @param str The literal string to match against
562 * @param mask The glob or CIDR pattern to match against.
563 * @param map The character map to use when matching.
565 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
566 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
568 /** Matches a hostname and IP against a space delimited list of hostmasks.
569 * @param masks The space delimited masks to match against.
570 * @param hostname The hostname to try and match.
571 * @param ipaddr The IP address to try and match.
573 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
575 /** Return true if the given parameter is a valid nick!user\@host mask
576 * @param mask A nick!user\@host masak to match against
577 * @return True i the mask is valid
579 static bool IsValidMask(const std::string& mask);
581 /** Strips all color codes from the given string
582 * @param sentence The string to strip from
584 static void StripColor(std::string &sentence);
586 /** Parses color codes from string values to actual color codes
587 * @param input The data to process
589 static void ProcessColors(file_cache& input);
591 /** Rehash the local server
592 * @param uuid The uuid of the user who started the rehash, can be empty
594 void Rehash(const std::string& uuid = "");
596 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
597 * @param str A string containing a time in the form 1y2w3d4h6m5s
598 * (one year, two weeks, three days, four hours, six minutes and five seconds)
599 * @return The total number of seconds
601 static unsigned long Duration(const std::string& str);
603 /** Attempt to compare a password to a string from the config file.
604 * This will be passed to handling modules which will compare the data
605 * against possible hashed equivalents in the input string.
606 * @param ex The object (user, server, whatever) causing the comparison.
607 * @param data The data from the config file
608 * @param input The data input by the oper
609 * @param hashtype The hash from the config file
610 * @return True if the strings match, false if they do not
612 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
614 /** Returns the full version string of this ircd
615 * @return The version string
617 std::string GetVersionString(bool getFullVersion = false);
619 /** Attempt to write the process id to a given file
620 * @param filename The PID file to attempt to write to
621 * @return This function may bail if the file cannot be written
623 void WritePID(const std::string &filename);
625 /** This constructor initialises all the subsystems and reads the config file.
626 * @param argc The argument count passed to main()
627 * @param argv The argument list passed to main()
628 * @throw <anything> If anything is thrown from here and makes it to
629 * you, you should probably just give up and go home. Yes, really.
630 * It's that bad. Higher level classes should catch any non-fatal exceptions.
632 InspIRCd(int argc, char** argv);
634 /** Send a line of WHOIS data to a user.
635 * @param user user to send the line to
636 * @param dest user being WHOISed
637 * @param numeric Numeric to send
638 * @param text Text of the numeric
640 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
642 /** Send a line of WHOIS data to a user.
643 * @param user user to send the line to
644 * @param dest user being WHOISed
645 * @param numeric Numeric to send
646 * @param format Format string for the numeric
647 * @param ... Parameters for the format string
649 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
651 /** Called to check whether a channel restriction mode applies to a user
652 * @param User that is attempting some action
653 * @param Channel that the action is being performed on
656 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
658 /** Prepare the ircd for restart or shutdown.
659 * This function unloads all modules which can be unloaded,
660 * closes all open sockets, and closes the logfile.
664 /** Return a time_t as a human-readable string.
666 static std::string TimeString(time_t curtime);
668 /** Begin execution of the server.
669 * NOTE: this function NEVER returns. Internally,
670 * it will repeatedly loop.
674 char* GetReadBuffer()
676 return this->ReadBuffer;
683 class CommandModule : public Module
687 CommandModule() : cmd(this)
693 return Version(cmd.name, VF_VENDOR|VF_CORE);
697 inline void stdalgo::culldeleter::operator()(classbase* item)
700 ServerInstance->GlobalCulls.AddItem(item);