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"
93 #include "isupportmanager.h"
95 /** Template function to convert any input type to std::string
97 template<typename T> inline std::string ConvNumeric(const T &in)
105 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
110 std::reverse(out.begin(), out.end());
114 /** Template function to convert any input type to std::string
116 inline std::string ConvToStr(const int in)
118 return ConvNumeric(in);
121 /** Template function to convert any input type to std::string
123 inline std::string ConvToStr(const long in)
125 return ConvNumeric(in);
128 /** Template function to convert any input type to std::string
130 inline std::string ConvToStr(const char* in)
135 /** Template function to convert any input type to std::string
137 inline std::string ConvToStr(const bool in)
139 return (in ? "1" : "0");
142 /** Template function to convert any input type to std::string
144 inline std::string ConvToStr(char in)
146 return std::string(1, in);
149 /** Template function to convert any input type to std::string
151 template <class T> inline std::string ConvToStr(const T &in)
153 std::stringstream tmp;
154 if (!(tmp << in)) return std::string();
158 /** Template function to convert any input type to any other type
159 * (usually an integer or numeric type)
161 template<typename T> inline long ConvToInt(const T &in)
163 std::stringstream tmp;
164 if (!(tmp << in)) return 0;
165 return atol(tmp.str().c_str());
168 inline uint64_t ConvToUInt64(const std::string& in)
171 std::istringstream tmp(in);
177 /** This class contains various STATS counters
178 * It is used by the InspIRCd class, which internally
179 * has an instance of it.
184 /** Number of accepted connections
186 unsigned long Accept;
187 /** Number of failed accepts
189 unsigned long Refused;
190 /** Number of unknown commands seen
192 unsigned long Unknown;
193 /** Number of nickname collisions handled
195 unsigned long Collisions;
196 /** Number of DNS queries sent out
199 /** Number of good DNS replies received
200 * NOTE: This may not tally to the number sent out,
201 * due to timeouts and other latency issues.
203 unsigned long DnsGood;
204 /** Number of bad (negative) DNS replies received
205 * NOTE: This may not tally to the number sent out,
206 * due to timeouts and other latency issues.
208 unsigned long DnsBad;
209 /** Number of inbound connections seen
211 unsigned long Connects;
212 /** Total bytes of data transmitted
215 /** Total bytes of data received
219 /** Cpu usage at last sample
222 /** Time QP sample was read
224 LARGE_INTEGER LastSampled;
227 LARGE_INTEGER QPFrequency;
229 /** Cpu usage at last sample
232 /** Time last sample was read
234 timespec LastSampled;
236 /** The constructor initializes all the counts to zero
239 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
240 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
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 /** Thread engine, Handles threading where required
337 ThreadEngine Threads;
339 /** The thread/class used to read config files in REHASH and on startup
341 ConfigReaderThread* ConfigThread;
343 /** LogManager handles logging.
347 /** ModuleManager contains everything related to loading/unloading
350 ModuleManager Modules;
352 /** BanCacheManager is used to speed up checking of restrictions on connection
355 BanCacheManager BanCache;
357 /** Stats class, holds miscellaneous stats counters
361 /** Server Config class, holds configuration file data
363 ServerConfig* Config;
365 /** Snomask manager - handles routing of snomask messages
370 /** Timer manager class, triggers Timer timer events
374 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
376 XLineManager* XLines;
378 /** User manager. Various methods and data associated with users.
382 /** Channel list, a hash_map containing all channels XXX move to channel manager class
386 /** List of the open ports
388 std::vector<ListenSocket*> ports;
390 /** Set to the current signal recieved
392 static sig_atomic_t s_signal;
394 /** Protocol interface, overridden by server protocol modules
396 ProtocolInterface* PI;
398 /** Default implementation of the ProtocolInterface, does nothing
400 ProtocolInterface DefaultProtocolInterface;
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 /** Find a user in the nick hash.
449 * If the user cant be found in the nick hash check the uuid hash
450 * @param nick The nickname to find
451 * @return A pointer to the user, or NULL if the user does not exist
453 User* FindNick(const std::string &nick);
455 /** Find a user in the nick hash ONLY
457 User* FindNickOnly(const std::string &nick);
459 /** Find a channel in the channels hash
460 * @param chan The channel to find
461 * @return A pointer to the channel, or NULL if the channel does not exist
463 Channel* FindChan(const std::string &chan);
465 /** Get a hash map containing all channels, keyed by their name
466 * @return A hash map mapping channel names to Channel pointers
468 chan_hash& GetChans() { return chanlist; }
470 /** Return true if a channel name is valid
471 * @param chname A channel name to verify
472 * @return True if the name is valid
474 caller1<bool, const std::string&> IsChannel;
476 /** Return true if str looks like a server ID
477 * @param sid string to check against
479 static bool IsSID(const std::string& sid);
481 /** Handles incoming signals after being set
482 * @param signal the signal recieved
484 void SignalHandler(int signal);
486 /** Sets the signal recieved
487 * @param signal the signal recieved
489 static void SetSignal(int signal);
491 /** Causes the server to exit after unloading modules and
492 * closing all open file descriptors.
494 * @param status The exit code to give to the operating system
495 * (See the ExitStatus enum for valid values)
497 void Exit(int status);
499 /** Causes the server to exit immediately with exit code 0.
500 * The status code is required for signal handlers, and ignored.
502 static void QuickExit(int status);
504 /** Formats the input string with the specified arguments.
505 * @param formatString The string to format
506 * @param ... A variable number of format arguments.
507 * @return The formatted string
509 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
510 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
512 /** Send an error notice to all local users, opered and unopered
513 * @param s The error string to send
515 void SendError(const std::string &s);
517 /** Return true if a nickname is valid
518 * @param n A nickname to verify
519 * @return True if the nick is valid
521 caller1<bool, const std::string&> IsNick;
523 /** Return true if an ident is valid
524 * @param An ident to verify
525 * @return True if the ident is valid
527 caller1<bool, const std::string&> IsIdent;
529 /** Match two strings using pattern matching, optionally, with a map
530 * to check case against (may be NULL). If map is null, match will be case insensitive.
531 * @param str The literal string to match against
532 * @param mask The glob pattern to match against.
533 * @param map The character map to use when matching.
535 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
536 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
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 * Supports CIDR patterns as well as globs.
541 * @param str The literal string to match against
542 * @param mask The glob or CIDR pattern to match against.
543 * @param map The character map to use when matching.
545 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
546 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
548 /** Matches a hostname and IP against a space delimited list of hostmasks.
549 * @param masks The space delimited masks to match against.
550 * @param hostname The hostname to try and match.
551 * @param ipaddr The IP address to try and match.
553 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
555 /** Return true if the given parameter is a valid nick!user\@host mask
556 * @param mask A nick!user\@host masak to match against
557 * @return True i the mask is valid
559 static bool IsValidMask(const std::string& mask);
561 /** Strips all color codes from the given string
562 * @param sentence The string to strip from
564 static void StripColor(std::string &sentence);
566 /** Parses color codes from string values to actual color codes
567 * @param input The data to process
569 static void ProcessColors(file_cache& input);
571 /** Rehash the local server
572 * @param uuid The uuid of the user who started the rehash, can be empty
574 void Rehash(const std::string& uuid = "");
576 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
577 * @param str A string containing a time in the form 1y2w3d4h6m5s
578 * (one year, two weeks, three days, four hours, six minutes and five seconds)
579 * @return The total number of seconds
581 static unsigned long Duration(const std::string& str);
583 /** Attempt to compare a password to a string from the config file.
584 * This will be passed to handling modules which will compare the data
585 * against possible hashed equivalents in the input string.
586 * @param ex The object (user, server, whatever) causing the comparison.
587 * @param data The data from the config file
588 * @param input The data input by the oper
589 * @param hashtype The hash from the config file
590 * @return True if the strings match, false if they do not
592 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
594 /** Returns the full version string of this ircd
595 * @return The version string
597 std::string GetVersionString(bool getFullVersion = false);
599 /** Attempt to write the process id to a given file
600 * @param filename The PID file to attempt to write to
601 * @return This function may bail if the file cannot be written
603 void WritePID(const std::string &filename);
605 /** This constructor initialises all the subsystems and reads the config file.
606 * @param argc The argument count passed to main()
607 * @param argv The argument list passed to main()
608 * @throw <anything> If anything is thrown from here and makes it to
609 * you, you should probably just give up and go home. Yes, really.
610 * It's that bad. Higher level classes should catch any non-fatal exceptions.
612 InspIRCd(int argc, char** argv);
614 /** Send a line of WHOIS data to a user.
615 * @param user user to send the line to
616 * @param dest user being WHOISed
617 * @param numeric Numeric to send
618 * @param text Text of the numeric
620 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
622 /** Send a line of WHOIS data to a user.
623 * @param user user to send the line to
624 * @param dest user being WHOISed
625 * @param numeric Numeric to send
626 * @param format Format string for the numeric
627 * @param ... Parameters for the format string
629 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
631 /** Called to check whether a channel restriction mode applies to a user
632 * @param User that is attempting some action
633 * @param Channel that the action is being performed on
636 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
638 /** Prepare the ircd for restart or shutdown.
639 * This function unloads all modules which can be unloaded,
640 * closes all open sockets, and closes the logfile.
644 /** Return a time_t as a human-readable string.
645 * @param format The format to retrieve the date/time in. See `man 3 strftime`
646 * for more information. If NULL, "%a %b %d %T %Y" is assumed.
647 * @param utc True to convert the time to string as-is, false to convert it to local time first.
648 * @return A string representing the given date/time.
650 static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
652 /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
653 * returns false immediately (leaking information about the length), otherwise it compares each
654 * character and only returns after all characters have been compared.
655 * @param one First string
656 * @param two Second string
657 * @return True if the strings match, false if they don't
659 static bool TimingSafeCompare(const std::string& one, const std::string& two);
661 /** Begin execution of the server.
662 * NOTE: this function NEVER returns. Internally,
663 * it will repeatedly loop.
667 char* GetReadBuffer()
669 return this->ReadBuffer;
676 class CommandModule : public Module
680 CommandModule() : cmd(this)
686 return Version(cmd.name, VF_VENDOR|VF_CORE);
690 inline void stdalgo::culldeleter::operator()(classbase* item)
693 ServerInstance->GlobalCulls.AddItem(item);