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/>.
47 #include "intrusive_list.h"
50 #include "aligned_storage.h"
54 CoreExport extern InspIRCd* ServerInstance;
56 /** Base class for manager classes that are still accessed using -> but are no longer pointers
63 return static_cast<T*>(this);
70 #include "consolecolors.h"
72 #include "cull_list.h"
73 #include "extensible.h"
74 #include "fileutils.h"
84 #include "usermanager.h"
87 #include "command_parse.h"
89 #include "socketengine.h"
91 #include "filelogger.h"
93 #include "threadengine.h"
94 #include "configreader.h"
95 #include "inspstring.h"
98 #include "isupportmanager.h"
100 /** This class contains various STATS counters
101 * It is used by the InspIRCd class, which internally
102 * has an instance of it.
107 /** Number of accepted connections
109 unsigned long Accept;
110 /** Number of failed accepts
112 unsigned long Refused;
113 /** Number of unknown commands seen
115 unsigned long Unknown;
116 /** Number of nickname collisions handled
118 unsigned long Collisions;
119 /** Number of DNS queries sent out
122 /** Number of good DNS replies received
123 * NOTE: This may not tally to the number sent out,
124 * due to timeouts and other latency issues.
126 unsigned long DnsGood;
127 /** Number of bad (negative) DNS replies received
128 * NOTE: This may not tally to the number sent out,
129 * due to timeouts and other latency issues.
131 unsigned long DnsBad;
132 /** Number of inbound connections seen
134 unsigned long Connects;
135 /** Total bytes of data transmitted
138 /** Total bytes of data received
142 /** Cpu usage at last sample
145 /** Time QP sample was read
147 LARGE_INTEGER LastSampled;
150 LARGE_INTEGER QPFrequency;
152 /** Cpu usage at last sample
155 /** Time last sample was read
157 timespec LastSampled;
159 /** The constructor initializes all the counts to zero
162 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
163 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
168 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
169 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
170 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
171 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
173 /** The main class of the irc server.
174 * This class contains instances of all the other classes in this software.
175 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
176 * object, and a list of active Module objects, and facilities for Module
177 * objects to interact with the core system it implements.
179 class CoreExport InspIRCd
182 /** Set up the signal handlers
186 /** Daemonize the ircd and close standard input/output streams
187 * @return True if the program daemonized succesfully
191 /** The current time, updated in the mainloop
193 struct timespec TIME;
195 /** A 64k buffer used to read socket data into
196 * NOTE: update ValidateNetBufferSize if you change this
198 char ReadBuffer[65535];
200 /** Check we aren't running as root, and exit if we are
201 * with exit code EXIT_STATUS_ROOT.
209 /** Global cull list, will be processed on next iteration
211 CullList GlobalCulls;
212 /** Actions that must happen outside of the current call stack */
213 ActionList AtomicActions;
217 IsNickHandler HandleIsNick;
218 IsIdentHandler HandleIsIdent;
219 IsChannelHandler HandleIsChannel;
220 GenRandomHandler HandleGenRandom;
222 /** 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
225 * SendMode expects a User* to send the numeric replies
226 * back to, so we create it a fake user that isnt in the user
227 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
228 * falls into the abyss :p
230 FakeUser* FakeClient;
232 /** Find a user in the UUID hash
233 * @param uid The UUID to find
234 * @return A pointer to the user, or NULL if the user does not exist
236 User* FindUUID(const std::string &uid);
238 /** Time this ircd was booted
242 /** Config file pathname specified on the commandline or via ./configure
244 std::string ConfigFileName;
246 ExtensionManager Extensions;
248 /** Mode handler, handles mode setting and removal
252 /** Command parser, handles client to server commands
254 CommandParser Parser;
256 /** Thread engine, Handles threading where required
258 ThreadEngine Threads;
260 /** The thread/class used to read config files in REHASH and on startup
262 ConfigReaderThread* ConfigThread;
264 /** LogManager handles logging.
268 /** ModuleManager contains everything related to loading/unloading
271 ModuleManager Modules;
273 /** BanCacheManager is used to speed up checking of restrictions on connection
276 BanCacheManager BanCache;
278 /** Stats class, holds miscellaneous stats counters
282 /** Server Config class, holds configuration file data
284 ServerConfig* Config;
286 /** Snomask manager - handles routing of snomask messages
291 /** Timer manager class, triggers Timer timer events
295 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
297 XLineManager* XLines;
299 /** User manager. Various methods and data associated with users.
303 /** Channel list, a hash_map containing all channels XXX move to channel manager class
307 /** List of the open ports
309 std::vector<ListenSocket*> ports;
311 /** Set to the current signal recieved
313 static sig_atomic_t s_signal;
315 /** Protocol interface, overridden by server protocol modules
317 ProtocolInterface* PI;
319 /** Default implementation of the ProtocolInterface, does nothing
321 ProtocolInterface DefaultProtocolInterface;
323 /** Manages the generation and transmission of ISUPPORT. */
324 ISupportManager ISupport;
326 /** Get the current time
327 * Because this only calls time() once every time around the mainloop,
328 * it is much faster than calling time() directly.
329 * @return The current time as an epoch value (time_t)
331 inline time_t Time() { return TIME.tv_sec; }
332 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
333 inline long Time_ns() { return TIME.tv_nsec; }
334 /** Update the current time. Don't call this unless you have reason to do so. */
337 /** Generate a random string with the given length
338 * @param length The length in bytes
339 * @param printable if false, the string will use characters 0-255; otherwise,
340 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
342 std::string GenRandomStr(int length, bool printable = true);
343 /** Generate a random integer.
344 * This is generally more secure than rand()
346 unsigned long GenRandomInt(unsigned long max);
348 /** Fill a buffer with random bits */
349 caller2<void, char*, size_t> GenRandom;
351 /** Bind all ports specified in the configuration file.
352 * @return The number of ports bound without error
354 int BindPorts(FailedPortList &failed_ports);
356 /** Find a user in the nick hash.
357 * If the user cant be found in the nick hash check the uuid hash
358 * @param nick The nickname to find
359 * @return A pointer to the user, or NULL if the user does not exist
361 User* FindNick(const std::string &nick);
363 /** Find a user in the nick hash ONLY
365 User* FindNickOnly(const std::string &nick);
367 /** Find a channel in the channels hash
368 * @param chan The channel to find
369 * @return A pointer to the channel, or NULL if the channel does not exist
371 Channel* FindChan(const std::string &chan);
373 /** Get a hash map containing all channels, keyed by their name
374 * @return A hash map mapping channel names to Channel pointers
376 chan_hash& GetChans() { return chanlist; }
378 /** Return true if a channel name is valid
379 * @param chname A channel name to verify
380 * @return True if the name is valid
382 caller1<bool, const std::string&> IsChannel;
384 /** Return true if str looks like a server ID
385 * @param sid string to check against
387 static bool IsSID(const std::string& sid);
389 /** Handles incoming signals after being set
390 * @param signal the signal recieved
392 void SignalHandler(int signal);
394 /** Sets the signal recieved
395 * @param signal the signal recieved
397 static void SetSignal(int signal);
399 /** Causes the server to exit after unloading modules and
400 * closing all open file descriptors.
402 * @param status The exit code to give to the operating system
403 * (See the ExitStatus enum for valid values)
405 void Exit(int status);
407 /** Causes the server to exit immediately with exit code 0.
408 * The status code is required for signal handlers, and ignored.
410 static void QuickExit(int status);
412 /** Formats the input string with the specified arguments.
413 * @param formatString The string to format
414 * @param ... A variable number of format arguments.
415 * @return The formatted string
417 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
418 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
420 /** Return true if a nickname is valid
421 * @param n A nickname to verify
422 * @return True if the nick is valid
424 caller1<bool, const std::string&> IsNick;
426 /** Return true if an ident is valid
427 * @param An ident to verify
428 * @return True if the ident is valid
430 caller1<bool, const std::string&> IsIdent;
432 /** Match two strings using pattern matching, optionally, with a map
433 * to check case against (may be NULL). If map is null, match will be case insensitive.
434 * @param str The literal string to match against
435 * @param mask The glob pattern to match against.
436 * @param map The character map to use when matching.
438 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
439 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
441 /** Match two strings using pattern matching, optionally, with a map
442 * to check case against (may be NULL). If map is null, match will be case insensitive.
443 * Supports CIDR patterns as well as globs.
444 * @param str The literal string to match against
445 * @param mask The glob or CIDR pattern to match against.
446 * @param map The character map to use when matching.
448 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
449 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
451 /** Matches a hostname and IP against a space delimited list of hostmasks.
452 * @param masks The space delimited masks to match against.
453 * @param hostname The hostname to try and match.
454 * @param ipaddr The IP address to try and match.
456 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
458 /** Return true if the given parameter is a valid nick!user\@host mask
459 * @param mask A nick!user\@host masak to match against
460 * @return True i the mask is valid
462 static bool IsValidMask(const std::string& mask);
464 /** Strips all color and control codes except 001 from the given string
465 * @param sentence The string to strip from
467 static void StripColor(std::string &sentence);
469 /** Parses color codes from string values to actual color codes
470 * @param input The data to process
472 static void ProcessColors(file_cache& input);
474 /** Rehash the local server
475 * @param uuid The uuid of the user who started the rehash, can be empty
477 void Rehash(const std::string& uuid = "");
479 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
480 * @param str A string containing a time in the form 1y2w3d4h6m5s
481 * (one year, two weeks, three days, four hours, six minutes and five seconds)
482 * @return The total number of seconds
484 static unsigned long Duration(const std::string& str);
486 /** Attempt to compare a password to a string from the config file.
487 * This will be passed to handling modules which will compare the data
488 * against possible hashed equivalents in the input string.
489 * @param ex The object (user, server, whatever) causing the comparison.
490 * @param data The data from the config file
491 * @param input The data input by the oper
492 * @param hashtype The hash from the config file
493 * @return True if the strings match, false if they do not
495 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
497 /** Returns the full version string of this ircd
498 * @return The version string
500 std::string GetVersionString(bool getFullVersion = false);
502 /** Attempt to write the process id to a given file
503 * @param filename The PID file to attempt to write to
504 * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure
505 * @return This function may bail if the file cannot be written
507 void WritePID(const std::string& filename, bool exitonfail = true);
509 /** This constructor initialises all the subsystems and reads the config file.
510 * @param argc The argument count passed to main()
511 * @param argv The argument list passed to main()
512 * @throw <anything> If anything is thrown from here and makes it to
513 * you, you should probably just give up and go home. Yes, really.
514 * It's that bad. Higher level classes should catch any non-fatal exceptions.
516 InspIRCd(int argc, char** argv);
518 /** Prepare the ircd for restart or shutdown.
519 * This function unloads all modules which can be unloaded,
520 * closes all open sockets, and closes the logfile.
524 /** Return a time_t as a human-readable string.
525 * @param format The format to retrieve the date/time in. See `man 3 strftime`
526 * for more information. If NULL, "%a %b %d %T %Y" is assumed.
527 * @param curtime The timestamp to convert to a human-readable string.
528 * @param utc True to convert the time to string as-is, false to convert it to local time first.
529 * @return A string representing the given date/time.
531 static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
533 /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
534 * returns false immediately (leaking information about the length), otherwise it compares each
535 * character and only returns after all characters have been compared.
536 * @param one First string
537 * @param two Second string
538 * @return True if the strings match, false if they don't
540 static bool TimingSafeCompare(const std::string& one, const std::string& two);
542 /** Begin execution of the server.
543 * NOTE: this function NEVER returns. Internally,
544 * it will repeatedly loop.
548 char* GetReadBuffer()
550 return this->ReadBuffer;
557 class CommandModule : public Module
561 CommandModule() : cmd(this)
567 return Version(cmd.name, VF_VENDOR|VF_CORE);
571 inline void stdalgo::culldeleter::operator()(classbase* item)
574 ServerInstance->GlobalCulls.AddItem(item);
577 #include "numericbuilder.h"
578 #include "modules/whois.h"
579 #include "modules/stats.h"