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;
55 #include "consolecolors.h"
57 #include "cull_list.h"
58 #include "extensible.h"
59 #include "fileutils.h"
68 #include "usermanager.h"
71 #include "command_parse.h"
73 #include "socketengine.h"
75 #include "filelogger.h"
77 #include "threadengine.h"
78 #include "configreader.h"
79 #include "inspstring.h"
83 /** Returned by some functions to indicate failure.
87 /** Template function to convert any input type to std::string
89 template<typename T> inline std::string ConvNumeric(const T &in)
97 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
102 std::reverse(out.begin(), out.end());
106 /** Template function to convert any input type to std::string
108 inline std::string ConvToStr(const int in)
110 return ConvNumeric(in);
113 /** Template function to convert any input type to std::string
115 inline std::string ConvToStr(const long in)
117 return ConvNumeric(in);
120 /** Template function to convert any input type to std::string
122 inline std::string ConvToStr(const char* in)
127 /** Template function to convert any input type to std::string
129 inline std::string ConvToStr(const bool in)
131 return (in ? "1" : "0");
134 /** Template function to convert any input type to std::string
136 inline std::string ConvToStr(char in)
138 return std::string(1, in);
141 /** Template function to convert any input type to std::string
143 template <class T> inline std::string ConvToStr(const T &in)
145 std::stringstream tmp;
146 if (!(tmp << in)) return std::string();
150 /** Template function to convert any input type to any other type
151 * (usually an integer or numeric type)
153 template<typename T> inline long ConvToInt(const T &in)
155 std::stringstream tmp;
156 if (!(tmp << in)) return 0;
157 return atol(tmp.str().c_str());
160 inline uint64_t ConvToUInt64(const std::string& in)
163 std::istringstream tmp(in);
169 /** This class contains various STATS counters
170 * It is used by the InspIRCd class, which internally
171 * has an instance of it.
176 /** Number of accepted connections
178 unsigned long Accept;
179 /** Number of failed accepts
181 unsigned long Refused;
182 /** Number of unknown commands seen
184 unsigned long Unknown;
185 /** Number of nickname collisions handled
187 unsigned long Collisions;
188 /** Number of DNS queries sent out
191 /** Number of good DNS replies received
192 * NOTE: This may not tally to the number sent out,
193 * due to timeouts and other latency issues.
195 unsigned long DnsGood;
196 /** Number of bad (negative) DNS replies received
197 * NOTE: This may not tally to the number sent out,
198 * due to timeouts and other latency issues.
200 unsigned long DnsBad;
201 /** Number of inbound connections seen
203 unsigned long Connects;
204 /** Total bytes of data transmitted
207 /** Total bytes of data received
211 /** Cpu usage at last sample
214 /** Time QP sample was read
216 LARGE_INTEGER LastSampled;
219 LARGE_INTEGER QPFrequency;
221 /** Cpu usage at last sample
224 /** Time last sample was read
226 timespec LastSampled;
228 /** The constructor initializes all the counts to zero
231 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
232 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
237 /** This class manages the generation and transmission of ISUPPORT. */
238 class CoreExport ISupportManager
241 /** The generated lines which are sent to clients. */
242 std::vector<std::string> Lines;
245 /** (Re)build the ISUPPORT vector. */
248 /** Returns the std::vector of ISUPPORT lines. */
249 const std::vector<std::string>& GetLines()
254 /** Send the 005 numerics (ISUPPORT) to a user. */
255 void SendTo(LocalUser* user);
258 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
259 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
260 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
261 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
262 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
264 /** The main class of the irc server.
265 * This class contains instances of all the other classes in this software.
266 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
267 * object, and a list of active Module objects, and facilities for Module
268 * objects to interact with the core system it implements.
270 class CoreExport InspIRCd
273 /** Set up the signal handlers
277 /** Daemonize the ircd and close standard input/output streams
278 * @return True if the program daemonized succesfully
282 /** The current time, updated in the mainloop
284 struct timespec TIME;
286 /** A 64k buffer used to read socket data into
287 * NOTE: update ValidateNetBufferSize if you change this
289 char ReadBuffer[65535];
291 /** Check we aren't running as root, and exit if we are
292 * with exit code EXIT_STATUS_ROOT.
300 /** Global cull list, will be processed on next iteration
302 CullList GlobalCulls;
303 /** Actions that must happen outside of the current call stack */
304 ActionList AtomicActions;
308 IsNickHandler HandleIsNick;
309 IsIdentHandler HandleIsIdent;
310 OnCheckExemptionHandler HandleOnCheckExemption;
311 IsChannelHandler HandleIsChannel;
312 GenRandomHandler HandleGenRandom;
314 /** 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
317 * SendMode expects a User* to send the numeric replies
318 * back to, so we create it a fake user that isnt in the user
319 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
320 * falls into the abyss :p
322 FakeUser* FakeClient;
324 /** Find a user in the UUID hash
325 * @param uid The UUID to find
326 * @return A pointer to the user, or NULL if the user does not exist
328 User* FindUUID(const std::string &uid);
330 /** Time this ircd was booted
334 /** Config file pathname specified on the commandline or via ./configure
336 std::string ConfigFileName;
338 ExtensionManager Extensions;
340 /** Mode handler, handles mode setting and removal
344 /** Command parser, handles client to server commands
346 CommandParser* Parser;
348 /** Thread engine, Handles threading where required
350 ThreadEngine Threads;
352 /** The thread/class used to read config files in REHASH and on startup
354 ConfigReaderThread* ConfigThread;
356 /** LogManager handles logging.
360 /** ModuleManager contains everything related to loading/unloading
363 ModuleManager* Modules;
365 /** BanCacheManager is used to speed up checking of restrictions on connection
368 BanCacheManager BanCache;
370 /** Stats class, holds miscellaneous stats counters
374 /** Server Config class, holds configuration file data
376 ServerConfig* Config;
378 /** Snomask manager - handles routing of snomask messages
383 /** Timer manager class, triggers Timer timer events
387 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
389 XLineManager* XLines;
391 /** User manager. Various methods and data associated with users.
395 /** Channel list, a hash_map containing all channels XXX move to channel manager class
399 /** List of the open ports
401 std::vector<ListenSocket*> ports;
403 /** Set to the current signal recieved
405 static sig_atomic_t s_signal;
407 /** Protocol interface, overridden by server protocol modules
409 ProtocolInterface* PI;
411 /** Holds extensible for user operquit
413 StringExtItem OperQuit;
415 /** Manages the generation and transmission of ISUPPORT. */
416 ISupportManager ISupport;
418 /** Get the current time
419 * Because this only calls time() once every time around the mainloop,
420 * it is much faster than calling time() directly.
421 * @return The current time as an epoch value (time_t)
423 inline time_t Time() { return TIME.tv_sec; }
424 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
425 inline long Time_ns() { return TIME.tv_nsec; }
426 /** Update the current time. Don't call this unless you have reason to do so. */
429 /** Generate a random string with the given length
430 * @param length The length in bytes
431 * @param printable if false, the string will use characters 0-255; otherwise,
432 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
434 std::string GenRandomStr(int length, bool printable = true);
435 /** Generate a random integer.
436 * This is generally more secure than rand()
438 unsigned long GenRandomInt(unsigned long max);
440 /** Fill a buffer with random bits */
441 caller2<void, char*, size_t> GenRandom;
443 /** Bind all ports specified in the configuration file.
444 * @return The number of ports bound without error
446 int BindPorts(FailedPortList &failed_ports);
448 /** Binds a socket on an already open file descriptor
449 * @param sockfd A valid file descriptor of an open socket
450 * @param port The port number to bind to
451 * @param addr The address to bind to (IP only)
452 * @param dolisten Should this port be listened on?
453 * @return True if the port was bound successfully
455 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
457 /** Find a user in the nick hash.
458 * If the user cant be found in the nick hash check the uuid hash
459 * @param nick The nickname to find
460 * @return A pointer to the user, or NULL if the user does not exist
462 User* FindNick(const std::string &nick);
464 /** Find a user in the nick hash ONLY
466 User* FindNickOnly(const std::string &nick);
468 /** Find a channel in the channels hash
469 * @param chan The channel to find
470 * @return A pointer to the channel, or NULL if the channel does not exist
472 Channel* FindChan(const std::string &chan);
474 /** Get a hash map containing all channels, keyed by their name
475 * @return A hash map mapping channel names to Channel pointers
477 chan_hash& GetChans() { return chanlist; }
479 /** Return true if a channel name is valid
480 * @param chname A channel name to verify
481 * @return True if the name is valid
483 caller1<bool, const std::string&> IsChannel;
485 /** Return true if str looks like a server ID
486 * @param sid string to check against
488 static bool IsSID(const std::string& sid);
490 /** Handles incoming signals after being set
491 * @param signal the signal recieved
493 void SignalHandler(int signal);
495 /** Sets the signal recieved
496 * @param signal the signal recieved
498 static void SetSignal(int signal);
500 /** Causes the server to exit after unloading modules and
501 * closing all open file descriptors.
503 * @param status The exit code to give to the operating system
504 * (See the ExitStatus enum for valid values)
506 void Exit(int status);
508 /** Causes the server to exit immediately with exit code 0.
509 * The status code is required for signal handlers, and ignored.
511 static void QuickExit(int status);
513 /** Formats the input string with the specified arguments.
514 * @param formatString The string to format
515 * @param ... A variable number of format arguments.
516 * @return The formatted string
518 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
519 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
521 /** Send an error notice to all local users, opered and unopered
522 * @param s The error string to send
524 void SendError(const std::string &s);
526 /** Return true if a nickname is valid
527 * @param n A nickname to verify
528 * @return True if the nick is valid
530 caller1<bool, const std::string&> IsNick;
532 /** Return true if an ident is valid
533 * @param An ident to verify
534 * @return True if the ident is valid
536 caller1<bool, const std::string&> IsIdent;
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 * @param str The literal string to match against
541 * @param mask The glob pattern to match against.
542 * @param map The character map to use when matching.
544 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
545 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
547 /** Match two strings using pattern matching, optionally, with a map
548 * to check case against (may be NULL). If map is null, match will be case insensitive.
549 * Supports CIDR patterns as well as globs.
550 * @param str The literal string to match against
551 * @param mask The glob or CIDR pattern to match against.
552 * @param map The character map to use when matching.
554 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
555 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
557 /** Matches a hostname and IP against a space delimited list of hostmasks.
558 * @param masks The space delimited masks to match against.
559 * @param hostname The hostname to try and match.
560 * @param ipaddr The IP address to try and match.
562 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
564 /** Return true if the given parameter is a valid nick!user\@host mask
565 * @param mask A nick!user\@host masak to match against
566 * @return True i the mask is valid
568 static bool IsValidMask(const std::string& mask);
570 /** Strips all color codes from the given string
571 * @param sentence The string to strip from
573 static void StripColor(std::string &sentence);
575 /** Parses color codes from string values to actual color codes
576 * @param input The data to process
578 static void ProcessColors(file_cache& input);
580 /** Rehash the local server
581 * @param uuid The uuid of the user who started the rehash, can be empty
583 void Rehash(const std::string& uuid = "");
585 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
586 * @param str A string containing a time in the form 1y2w3d4h6m5s
587 * (one year, two weeks, three days, four hours, six minutes and five seconds)
588 * @return The total number of seconds
590 static unsigned long Duration(const std::string& str);
592 /** Attempt to compare a password to a string from the config file.
593 * This will be passed to handling modules which will compare the data
594 * against possible hashed equivalents in the input string.
595 * @param ex The object (user, server, whatever) causing the comparison.
596 * @param data The data from the config file
597 * @param input The data input by the oper
598 * @param hashtype The hash from the config file
599 * @return True if the strings match, false if they do not
601 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
603 /** Returns the full version string of this ircd
604 * @return The version string
606 std::string GetVersionString(bool getFullVersion = false);
608 /** Attempt to write the process id to a given file
609 * @param filename The PID file to attempt to write to
610 * @return This function may bail if the file cannot be written
612 void WritePID(const std::string &filename);
614 /** This constructor initialises all the subsystems and reads the config file.
615 * @param argc The argument count passed to main()
616 * @param argv The argument list passed to main()
617 * @throw <anything> If anything is thrown from here and makes it to
618 * you, you should probably just give up and go home. Yes, really.
619 * It's that bad. Higher level classes should catch any non-fatal exceptions.
621 InspIRCd(int argc, char** argv);
623 /** Send a line of WHOIS data to a user.
624 * @param user user to send the line to
625 * @param dest user being WHOISed
626 * @param numeric Numeric to send
627 * @param text Text of the numeric
629 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
631 /** Send a line of WHOIS data to a user.
632 * @param user user to send the line to
633 * @param dest user being WHOISed
634 * @param numeric Numeric to send
635 * @param format Format string for the numeric
636 * @param ... Parameters for the format string
638 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
640 /** Called to check whether a channel restriction mode applies to a user
641 * @param User that is attempting some action
642 * @param Channel that the action is being performed on
645 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
647 /** Prepare the ircd for restart or shutdown.
648 * This function unloads all modules which can be unloaded,
649 * closes all open sockets, and closes the logfile.
653 /** Return a time_t as a human-readable string.
655 static std::string TimeString(time_t curtime);
657 /** Begin execution of the server.
658 * NOTE: this function NEVER returns. Internally,
659 * it will repeatedly loop.
663 char* GetReadBuffer()
665 return this->ReadBuffer;
672 class CommandModule : public Module
676 CommandModule() : cmd(this)
682 return Version(cmd.name, VF_VENDOR|VF_CORE);
686 inline void stdalgo::culldeleter::operator()(classbase* item)
689 ServerInstance->GlobalCulls.AddItem(item);