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 /** Perform background user events such as PING checks
275 void DoBackgroundUserStuff();
277 /** Returns true when all modules have done pre-registration checks on a user
278 * @param user The user to verify
279 * @return True if all modules have finished checking this user
281 bool AllModulesReportReady(LocalUser* user);
283 /** The current time, updated in the mainloop
285 struct timespec TIME;
287 /** A 64k buffer used to read socket data into
288 * NOTE: update ValidateNetBufferSize if you change this
290 char ReadBuffer[65535];
296 /** Global cull list, will be processed on next iteration
298 CullList GlobalCulls;
299 /** Actions that must happen outside of the current call stack */
300 ActionList AtomicActions;
304 IsNickHandler HandleIsNick;
305 IsIdentHandler HandleIsIdent;
306 OnCheckExemptionHandler HandleOnCheckExemption;
307 IsChannelHandler HandleIsChannel;
308 RehashHandler HandleRehash;
309 GenRandomHandler HandleGenRandom;
311 /** 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
314 * SendMode expects a User* to send the numeric replies
315 * back to, so we create it a fake user that isnt in the user
316 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
317 * falls into the abyss :p
319 FakeUser* FakeClient;
321 /** Find a user in the UUID hash
322 * @param uid The UUID to find
323 * @return A pointer to the user, or NULL if the user does not exist
325 User* FindUUID(const std::string &uid);
327 /** Time this ircd was booted
331 /** Config file pathname specified on the commandline or via ./configure
333 std::string ConfigFileName;
335 ExtensionManager Extensions;
337 /** Mode handler, handles mode setting and removal
341 /** Command parser, handles client to server commands
343 CommandParser* Parser;
345 /** Socket engine, handles socket activity events
349 /** Thread engine, Handles threading where required
351 ThreadEngine* Threads;
353 /** The thread/class used to read config files in REHASH and on startup
355 ConfigReaderThread* ConfigThread;
357 /** LogManager handles logging.
361 /** ModuleManager contains everything related to loading/unloading
364 ModuleManager* Modules;
366 /** BanCacheManager is used to speed up checking of restrictions on connection
369 BanCacheManager *BanCache;
371 /** Stats class, holds miscellaneous stats counters
375 /** Server Config class, holds configuration file data
377 ServerConfig* Config;
379 /** Snomask manager - handles routing of snomask messages
384 /** Timer manager class, triggers Timer timer events
386 TimerManager* Timers;
388 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
390 XLineManager* XLines;
392 /** User manager. Various methods and data associated with users.
396 /** Channel list, a hash_map containing all channels XXX move to channel manager class
400 /** List of the open ports
402 std::vector<ListenSocket*> ports;
404 /** Set to the current signal recieved
406 static sig_atomic_t s_signal;
408 /** Protocol interface, overridden by server protocol modules
410 ProtocolInterface* PI;
412 /** Holds extensible for user operquit
414 LocalStringExt OperQuit;
416 /** Manages the generation and transmission of ISUPPORT. */
417 ISupportManager ISupport;
419 /** Get the current time
420 * Because this only calls time() once every time around the mainloop,
421 * it is much faster than calling time() directly.
422 * @return The current time as an epoch value (time_t)
424 inline time_t Time() { return TIME.tv_sec; }
425 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
426 inline long Time_ns() { return TIME.tv_nsec; }
427 /** Update the current time. Don't call this unless you have reason to do so. */
430 /** Generate a random string with the given length
431 * @param length The length in bytes
432 * @param printable if false, the string will use characters 0-255; otherwise,
433 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
435 std::string GenRandomStr(int length, bool printable = true);
436 /** Generate a random integer.
437 * This is generally more secure than rand()
439 unsigned long GenRandomInt(unsigned long max);
441 /** Fill a buffer with random bits */
442 caller2<void, char*, size_t> GenRandom;
444 /** Bind all ports specified in the configuration file.
445 * @return The number of ports bound without error
447 int BindPorts(FailedPortList &failed_ports);
449 /** Binds a socket on an already open file descriptor
450 * @param sockfd A valid file descriptor of an open socket
451 * @param port The port number to bind to
452 * @param addr The address to bind to (IP only)
453 * @param dolisten Should this port be listened on?
454 * @return True if the port was bound successfully
456 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
458 /** Gets the GECOS (description) field of the given server.
459 * If the servername is not that of the local server, the name
460 * is passed to handling modules which will attempt to determine
461 * the GECOS that bleongs to the given servername.
462 * @param servername The servername to find the description of
463 * @return The description of this server, or of the local server
465 std::string GetServerDescription(const std::string& servername);
467 /** Find a user in the nick hash.
468 * If the user cant be found in the nick hash check the uuid hash
469 * @param nick The nickname to find
470 * @return A pointer to the user, or NULL if the user does not exist
472 User* FindNick(const std::string &nick);
474 /** Find a user in the nick hash ONLY
476 User* FindNickOnly(const std::string &nick);
478 /** Find a channel in the channels hash
479 * @param chan The channel to find
480 * @return A pointer to the channel, or NULL if the channel does not exist
482 Channel* FindChan(const std::string &chan);
484 /** Check we aren't running as root, and exit if we are
485 * @return Depending on the configuration, this function may never return
489 /** Return true if a channel name is valid
490 * @param chname A channel name to verify
491 * @return True if the name is valid
493 caller1<bool, const std::string&> IsChannel;
495 /** Return true if str looks like a server ID
496 * @param string to check against
498 static bool IsSID(const std::string& sid);
500 /** Rehash the local server
502 caller1<void, const std::string&> Rehash;
504 /** Handles incoming signals after being set
505 * @param signal the signal recieved
507 void SignalHandler(int signal);
509 /** Sets the signal recieved
510 * @param signal the signal recieved
512 static void SetSignal(int signal);
514 /** Causes the server to exit after unloading modules and
515 * closing all open file descriptors.
517 * @param status The exit code to give to the operating system
518 * (See the ExitStatus enum for valid values)
520 void Exit(int status);
522 /** Causes the server to exit immediately with exit code 0.
523 * The status code is required for signal handlers, and ignored.
527 * @param How you want it formatted
529 * @return The formatted string
531 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
532 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
534 static void QuickExit(int status);
536 /** Return a count of channels on the network
537 * @return The number of channels
539 long ChannelCount() const { return chanlist->size(); }
541 /** Send an error notice to all local users, opered and unopered
542 * @param s The error string to send
544 void SendError(const std::string &s);
546 /** Return true if a nickname is valid
547 * @param n A nickname to verify
548 * @return True if the nick is valid
550 caller1<bool, const std::string&> IsNick;
552 /** Return true if an ident is valid
553 * @param An ident to verify
554 * @return True if the ident is valid
556 caller1<bool, const std::string&> IsIdent;
558 /** Add a command to this server's command parser
559 * @param f A Command command handler object to add
560 * @throw ModuleException Will throw ModuleExcption if the command already exists
562 inline void AddCommand(Command *f)
564 Modules->AddService(*f);
567 /** Send a modechange.
568 * The parameters provided are identical to that sent to the
569 * handler for class cmd_mode.
570 * @param parameters The mode parameters
571 * @param user The user to send error messages to
573 void SendMode(const std::vector<std::string>& parameters, User *user);
575 /** Send a modechange and route it to the network.
576 * The parameters provided are identical to that sent to the
577 * handler for class cmd_mode.
578 * @param parameters The mode parameters
579 * @param user The user to send error messages to
581 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
583 /** Match two strings using pattern matching, optionally, with a map
584 * to check case against (may be NULL). If map is null, match will be case insensitive.
585 * @param str The literal string to match against
586 * @param mask The glob pattern to match against.
587 * @param map The character map to use when matching.
589 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
590 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
592 /** Match two strings using pattern matching, optionally, with a map
593 * to check case against (may be NULL). If map is null, match will be case insensitive.
594 * Supports CIDR patterns as well as globs.
595 * @param str The literal string to match against
596 * @param mask The glob or CIDR pattern to match against.
597 * @param map The character map to use when matching.
599 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
600 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
602 /** Matches a hostname and IP against a space delimited list of hostmasks.
603 * @param masks The space delimited masks to match against.
604 * @param hostname The hostname to try and match.
605 * @param ipaddr The IP address to try and match.
607 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
609 /** Return true if the given parameter is a valid nick!user\@host mask
610 * @param mask A nick!user\@host masak to match against
611 * @return True i the mask is valid
613 bool IsValidMask(const std::string &mask);
615 /** Strips all color codes from the given string
616 * @param sentence The string to strip from
618 static void StripColor(std::string &sentence);
620 /** Parses color codes from string values to actual color codes
621 * @param input The data to process
623 static void ProcessColors(file_cache& input);
625 /** Rehash the local server
629 /** Check if the given nickmask matches too many users, send errors to the given user
630 * @param nick A nickmask to match against
631 * @param user A user to send error text to
632 * @return True if the nick matches too many users
634 bool NickMatchesEveryone(const std::string &nick, User* user);
636 /** Check if the given IP mask matches too many users, send errors to the given user
637 * @param ip An ipmask to match against
638 * @param user A user to send error text to
639 * @return True if the ip matches too many users
641 bool IPMatchesEveryone(const std::string &ip, User* user);
643 /** Check if the given hostmask matches too many users, send errors to the given user
644 * @param mask A hostmask to match against
645 * @param user A user to send error text to
646 * @return True if the host matches too many users
648 bool HostMatchesEveryone(const std::string &mask, User* user);
650 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
651 * @param str A string containing a time in the form 1y2w3d4h6m5s
652 * (one year, two weeks, three days, four hours, six minutes and five seconds)
653 * @return The total number of seconds
655 static unsigned long Duration(const std::string& str);
657 /** Attempt to compare a password to a string from the config file.
658 * This will be passed to handling modules which will compare the data
659 * against possible hashed equivalents in the input string.
660 * @param ex The object (user, server, whatever) causing the comparison.
661 * @param data The data from the config file
662 * @param input The data input by the oper
663 * @param hashtype The hash from the config file
664 * @return 0 if the strings match, 1 or -1 if they do not
666 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
668 /** Check if a given server is a uline.
669 * An empty string returns true, this is by design.
670 * @param server The server to check for uline status
671 * @return True if the server is a uline OR the string is empty
673 bool ULine(const std::string& server);
675 /** Returns true if the uline is 'silent' (doesnt generate
676 * remote connect notices etc).
678 bool SilentULine(const std::string& server);
680 /** Returns the full version string of this ircd
681 * @return The version string
683 std::string GetVersionString(bool getFullVersion = false);
685 /** Attempt to write the process id to a given file
686 * @param filename The PID file to attempt to write to
687 * @return This function may bail if the file cannot be written
689 void WritePID(const std::string &filename);
691 /** This constructor initialises all the subsystems and reads the config file.
692 * @param argc The argument count passed to main()
693 * @param argv The argument list passed to main()
694 * @throw <anything> If anything is thrown from here and makes it to
695 * you, you should probably just give up and go home. Yes, really.
696 * It's that bad. Higher level classes should catch any non-fatal exceptions.
698 InspIRCd(int argc, char** argv);
700 /** Send a line of WHOIS data to a user.
701 * @param user user to send the line to
702 * @param dest user being WHOISed
703 * @param numeric Numeric to send
704 * @param text Text of the numeric
706 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
708 /** Send a line of WHOIS data to a user.
709 * @param user user to send the line to
710 * @param dest user being WHOISed
711 * @param numeric Numeric to send
712 * @param format Format string for the numeric
713 * @param ... Parameters for the format string
715 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
717 /** Called to check whether a channel restriction mode applies to a user
718 * @param User that is attempting some action
719 * @param Channel that the action is being performed on
722 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
724 /** Restart the server.
725 * This function will not return. If an error occurs,
726 * it will throw an instance of CoreException.
727 * @param reason The restart reason to show to all clients
728 * @throw CoreException An instance of CoreException indicating the error from execv().
730 void Restart(const std::string &reason);
732 /** Prepare the ircd for restart or shutdown.
733 * This function unloads all modules which can be unloaded,
734 * closes all open sockets, and closes the logfile.
738 /** Return a time_t as a human-readable string.
740 std::string TimeString(time_t curtime);
742 /** Begin execution of the server.
743 * NOTE: this function NEVER returns. Internally,
744 * it will repeatedly loop.
745 * @return The return value for this function is undefined.
749 char* GetReadBuffer()
751 return this->ReadBuffer;
758 class CommandModule : public Module
762 CommandModule() : cmd(this)
768 ServerInstance->Modules->AddService(cmd);
773 return Version(cmd.name, VF_VENDOR|VF_CORE);
777 inline void InspIRCd::SendMode(const std::vector<std::string>& parameters, User* user)
779 this->Modes->Process(parameters, user);