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/>.
28 // If the system has a pre-C11 stdint header this must be defined in
29 // order to use the numeric limit macros.
30 #define __STDC_LIMIT_MACROS
52 #include "intrusive_list.h"
55 #include "aligned_storage.h"
60 CoreExport extern InspIRCd* ServerInstance;
62 /** Base class for manager classes that are still accessed using -> but are no longer pointers
69 return static_cast<T*>(this);
75 #include "consolecolors.h"
76 #include "cull_list.h"
77 #include "serialize.h"
78 #include "extensible.h"
79 #include "fileutils.h"
90 #include "usermanager.h"
92 #include "command_parse.h"
94 #include "socketengine.h"
96 #include "filelogger.h"
99 #include "clientprotocol.h"
100 #include "threadengine.h"
101 #include "configreader.h"
102 #include "inspstring.h"
103 #include "protocol.h"
104 #include "bancache.h"
105 #include "isupportmanager.h"
107 /** This class contains various STATS counters
108 * It is used by the InspIRCd class, which internally
109 * has an instance of it.
114 /** Number of accepted connections
116 unsigned long Accept;
117 /** Number of failed accepts
119 unsigned long Refused;
120 /** Number of unknown commands seen
122 unsigned long Unknown;
123 /** Number of nickname collisions handled
125 unsigned long Collisions;
126 /** Number of DNS queries sent out
129 /** Number of good DNS replies received
130 * NOTE: This may not tally to the number sent out,
131 * due to timeouts and other latency issues.
133 unsigned long DnsGood;
134 /** Number of bad (negative) DNS replies received
135 * NOTE: This may not tally to the number sent out,
136 * due to timeouts and other latency issues.
138 unsigned long DnsBad;
139 /** Number of inbound connections seen
141 unsigned long Connects;
142 /** Total bytes of data transmitted
145 /** Total bytes of data received
149 /** Cpu usage at last sample
152 /** Time QP sample was read
154 LARGE_INTEGER LastSampled;
157 LARGE_INTEGER QPFrequency;
159 /** Cpu usage at last sample
162 /** Time last sample was read
164 timespec LastSampled;
166 /** The constructor initializes all the counts to zero
169 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
170 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
175 /** The main class of the irc server.
176 * This class contains instances of all the other classes in this software.
177 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
178 * object, and a list of active Module objects, and facilities for Module
179 * objects to interact with the core system it implements.
181 class CoreExport InspIRCd
184 /** Set up the signal handlers
188 /** Daemonize the ircd and close standard input/output streams
189 * @return True if the program daemonized succesfully
193 /** The current time, updated in the mainloop
195 struct timespec TIME;
197 /** A 64k buffer used to read socket data into
198 * NOTE: update ValidateNetBufferSize if you change this
200 char ReadBuffer[65535];
202 ClientProtocol::RFCEvents rfcevents;
204 /** Check we aren't running as root, and exit if we are
205 * with exit code EXIT_STATUS_ROOT.
213 /** Global cull list, will be processed on next iteration
215 CullList GlobalCulls;
216 /** Actions that must happen outside of the current call stack */
217 ActionList AtomicActions;
219 /** 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
222 * SendMode expects a User* to send the numeric replies
223 * back to, so we create it a fake user that isnt in the user
224 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
225 * falls into the abyss :p
227 FakeUser* FakeClient;
229 /** Find a user in the UUID hash
230 * @param uid The UUID to find
231 * @return A pointer to the user, or NULL if the user does not exist
233 User* FindUUID(const std::string &uid);
235 /** Time this ircd was booted
239 /** Config file pathname specified on the commandline or via ./configure
241 std::string ConfigFileName;
243 ExtensionManager Extensions;
245 /** Mode handler, handles mode setting and removal
249 /** Command parser, handles client to server commands
251 CommandParser Parser;
253 /** Thread engine, Handles threading where required
255 ThreadEngine Threads;
257 /** The thread/class used to read config files in REHASH and on startup
259 ConfigReaderThread* ConfigThread;
261 /** LogManager handles logging.
265 /** ModuleManager contains everything related to loading/unloading
268 ModuleManager Modules;
270 /** BanCacheManager is used to speed up checking of restrictions on connection
273 BanCacheManager BanCache;
275 /** Stats class, holds miscellaneous stats counters
279 /** Server Config class, holds configuration file data
281 ServerConfig* Config;
283 /** Snomask manager - handles routing of snomask messages
288 /** Timer manager class, triggers Timer timer events
292 /** X-line manager. Handles G/K/Q/E-line setting, removal and matching
294 XLineManager* XLines;
296 /** User manager. Various methods and data associated with users.
300 /** Channel list, a hash_map containing all channels XXX move to channel manager class
304 /** List of the open ports
306 std::vector<ListenSocket*> ports;
308 /** Set to the current signal received
310 static sig_atomic_t s_signal;
312 /** Protocol interface, overridden by server protocol modules
314 ProtocolInterface* PI;
316 /** Default implementation of the ProtocolInterface, does nothing
318 ProtocolInterface DefaultProtocolInterface;
320 /** Manages the generation and transmission of ISUPPORT. */
321 ISupportManager ISupport;
323 /** Get the current time
324 * Because this only calls time() once every time around the mainloop,
325 * it is much faster than calling time() directly.
326 * @return The current time as an epoch value (time_t)
328 inline time_t Time() { return TIME.tv_sec; }
329 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
330 inline long Time_ns() { return TIME.tv_nsec; }
331 /** Update the current time. Don't call this unless you have reason to do so. */
334 /** Generate a random string with the given length
335 * @param length The length in bytes
336 * @param printable if false, the string will use characters 0-255; otherwise,
337 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
339 std::string GenRandomStr(unsigned int length, bool printable = true);
340 /** Generate a random integer.
341 * This is generally more secure than rand()
343 unsigned long GenRandomInt(unsigned long max);
345 /** Fill a buffer with random bits */
346 TR1NS::function<void(char*, size_t)> GenRandom;
348 /** Fills the output buffer with the specified number of random characters.
349 * This is the default function for InspIRCd::GenRandom.
350 * @param output The output buffer to store random characters in.
351 * @param max The maximum number of random characters to put in the buffer.
353 static void DefaultGenRandom(char* output, size_t max);
355 /** Bind to a specific port from a config tag.
356 * @param tag the tag that contains bind information.
357 * @param sa The endpoint to listen on.
358 * @param old_ports Previously listening ports that may be on the same endpoint.
360 bool BindPort(ConfigTag* tag, const irc::sockets::sockaddrs& sa, std::vector<ListenSocket*>& old_ports);
362 /** Bind all ports specified in the configuration file.
363 * @return The number of ports bound without error
365 int BindPorts(FailedPortList &failed_ports);
367 /** Find a user in the nick hash.
368 * If the user cant be found in the nick hash check the uuid hash
369 * @param nick The nickname to find
370 * @return A pointer to the user, or NULL if the user does not exist
372 User* FindNick(const std::string &nick);
374 /** Find a user in the nick hash ONLY
376 User* FindNickOnly(const std::string &nick);
378 /** Find a channel in the channels hash
379 * @param chan The channel to find
380 * @return A pointer to the channel, or NULL if the channel does not exist
382 Channel* FindChan(const std::string &chan);
384 /** Get a hash map containing all channels, keyed by their name
385 * @return A hash map mapping channel names to Channel pointers
387 chan_hash& GetChans() { return chanlist; }
389 /** Determines whether an channel name is valid. */
390 TR1NS::function<bool(const std::string&)> IsChannel;
392 /** Determines whether a channel name is valid according to the RFC 1459 rules.
393 * This is the default function for InspIRCd::IsChannel.
394 * @param channel The channel name to validate.
395 * @return True if the channel name is valid according to RFC 1459 rules; otherwise, false.
397 static bool DefaultIsChannel(const std::string& channel);
399 /** Determines whether a hostname is valid according to RFC 5891 rules.
400 * @param host The hostname to validate.
401 * @return True if the hostname is valid; otherwise, false.
403 static bool IsHost(const std::string& host);
405 /** Return true if str looks like a server ID
406 * @param sid string to check against
408 static bool IsSID(const std::string& sid);
410 /** Handles incoming signals after being set
411 * @param signal the signal received
413 void SignalHandler(int signal);
415 /** Sets the signal received
416 * @param signal the signal received
418 static void SetSignal(int signal);
420 /** Causes the server to exit after unloading modules and
421 * closing all open file descriptors.
423 * @param status The exit code to give to the operating system
424 * (See the ExitStatus enum for valid values)
426 void Exit(int status);
428 /** Formats the input string with the specified arguments.
429 * @param formatString The string to format
430 * @param ... A variable number of format arguments.
431 * @return The formatted string
433 static std::string Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
434 static std::string Format(va_list& vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
436 /** Determines whether a nickname is valid. */
437 TR1NS::function<bool(const std::string&)> IsNick;
439 /** Determines whether a nickname is valid according to the RFC 1459 rules.
440 * This is the default function for InspIRCd::IsNick.
441 * @param nick The nickname to validate.
442 * @return True if the nickname is valid according to RFC 1459 rules; otherwise, false.
444 static bool DefaultIsNick(const std::string& nick);
446 /** Determines whether an ident is valid. */
447 TR1NS::function<bool(const std::string&)> IsIdent;
449 /** Determines whether a ident is valid according to the RFC 1459 rules.
450 * This is the default function for InspIRCd::IsIdent.
451 * @param ident The ident to validate.
452 * @return True if the ident is valid according to RFC 1459 rules; otherwise, false.
454 static bool DefaultIsIdent(const std::string& ident);
456 /** Match two strings using pattern matching, optionally, with a map
457 * to check case against (may be NULL). If map is null, match will be case insensitive.
458 * @param str The literal string to match against
459 * @param mask The glob pattern to match against.
460 * @param map The character map to use when matching.
462 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
463 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
465 /** Match two strings using pattern matching, optionally, with a map
466 * to check case against (may be NULL). If map is null, match will be case insensitive.
467 * Supports CIDR patterns as well as globs.
468 * @param str The literal string to match against
469 * @param mask The glob or CIDR pattern to match against.
470 * @param map The character map to use when matching.
472 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
473 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
475 /** Matches a hostname and IP against a space delimited list of hostmasks.
476 * @param masks The space delimited masks to match against.
477 * @param hostname The hostname to try and match.
478 * @param ipaddr The IP address to try and match.
480 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
482 /** Return true if the given parameter is a valid nick!user\@host mask
483 * @param mask A nick!user\@host masak to match against
484 * @return True i the mask is valid
486 static bool IsValidMask(const std::string& mask);
488 /** Strips all color and control codes except 001 from the given string
489 * @param sentence The string to strip from
491 static void StripColor(std::string &sentence);
493 /** Parses color codes from string values to actual color codes
494 * @param input The data to process
496 static void ProcessColors(file_cache& input);
498 /** Rehash the local server
499 * @param uuid The uuid of the user who started the rehash, can be empty
501 void Rehash(const std::string& uuid = "");
503 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
504 * @param str A string containing a time in the form 1y2w3d4h6m5s
505 * (one year, two weeks, three days, four hours, six minutes and five seconds)
506 * @return The total number of seconds
508 static unsigned long Duration(const std::string& str);
510 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
511 * @param str A string containing a time in the form 1y2w3d4h6m5s
512 * (one year, two weeks, three days, four hours, six minutes and five seconds)
513 * @param duration The location to place the parsed duration valur
514 * @return Whether the duration was a valid format or not
516 static bool Duration(const std::string& str, unsigned long& duration);
518 /** Determines whether a string contains a valid duration.
519 * @param str A string containing a time in the form 1y2w3d4h6m5s
520 * @return True if the string is a valid duration; otherwise, false.
522 static bool IsValidDuration(const std::string& str);
524 /** Return a duration in seconds as a human-readable string.
525 * @param duration The duration in seconds to convert to a human-readable string.
526 * @return A string representing the given duration.
528 static std::string DurationString(time_t duration);
530 /** Attempt to compare a password to a string from the config file.
531 * This will be passed to handling modules which will compare the data
532 * against possible hashed equivalents in the input string.
533 * @param ex The object (user, server, whatever) causing the comparison.
534 * @param data The data from the config file
535 * @param input The data input by the oper
536 * @param hashtype The hash from the config file
537 * @return True if the strings match, false if they do not
539 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
541 /** Returns the full version string of this ircd
542 * @return The version string
544 std::string GetVersionString(bool getFullVersion = false);
546 /** Attempt to write the process id to a given file
547 * @param filename The PID file to attempt to write to
548 * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure
549 * @return This function may bail if the file cannot be written
551 void WritePID(const std::string& filename, bool exitonfail = true);
553 /** This constructor initialises all the subsystems and reads the config file.
554 * @param argc The argument count passed to main()
555 * @param argv The argument list passed to main()
556 * @throw <anything> If anything is thrown from here and makes it to
557 * you, you should probably just give up and go home. Yes, really.
558 * It's that bad. Higher level classes should catch any non-fatal exceptions.
560 InspIRCd(int argc, char** argv);
562 /** Prepare the ircd for restart or shutdown.
563 * This function unloads all modules which can be unloaded,
564 * closes all open sockets, and closes the logfile.
568 /** Return a time_t as a human-readable string.
569 * @param format The format to retrieve the date/time in. See `man 3 strftime`
570 * for more information. If NULL, "%a %b %d %T %Y" is assumed.
571 * @param curtime The timestamp to convert to a human-readable string.
572 * @param utc True to convert the time to string as-is, false to convert it to local time first.
573 * @return A string representing the given date/time.
575 static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
577 /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
578 * returns false immediately (leaking information about the length), otherwise it compares each
579 * character and only returns after all characters have been compared.
580 * @param one First string
581 * @param two Second string
582 * @return True if the strings match, false if they don't
584 static bool TimingSafeCompare(const std::string& one, const std::string& two);
586 /** Begin execution of the server.
587 * NOTE: this function NEVER returns. Internally,
588 * it will repeatedly loop.
592 char* GetReadBuffer()
594 return this->ReadBuffer;
597 ClientProtocol::RFCEvents& GetRFCEvents() { return rfcevents; }
602 inline void stdalgo::culldeleter::operator()(classbase* item)
605 ServerInstance->GlobalCulls.AddItem(item);
608 inline void Channel::Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status, const CUList& except_list)
610 ClientProtocol::Event event(protoevprov, msg);
611 Write(event, status, except_list);
614 inline void LocalUser::Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg)
616 ClientProtocol::Event event(protoevprov, msg);
620 #include "numericbuilder.h"
621 #include "clientprotocolmsg.h"
622 #include "clientprotocolevent.h"