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"
50 CoreExport extern InspIRCd* ServerInstance;
54 #include "consolecolors.h"
56 #include "cull_list.h"
57 #include "extensible.h"
58 #include "fileutils.h"
67 #include "usermanager.h"
70 #include "command_parse.h"
72 #include "socketengine.h"
74 #include "filelogger.h"
76 #include "threadengine.h"
77 #include "configreader.h"
78 #include "inspstring.h"
81 /** Returned by some functions to indicate failure.
85 /** Template function to convert any input type to std::string
87 template<typename T> inline std::string ConvNumeric(const T &in)
95 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
100 std::reverse(out.begin(), out.end());
104 /** Template function to convert any input type to std::string
106 inline std::string ConvToStr(const int in)
108 return ConvNumeric(in);
111 /** Template function to convert any input type to std::string
113 inline std::string ConvToStr(const long in)
115 return ConvNumeric(in);
118 /** Template function to convert any input type to std::string
120 inline std::string ConvToStr(const char* in)
125 /** Template function to convert any input type to std::string
127 inline std::string ConvToStr(const bool in)
129 return (in ? "1" : "0");
132 /** Template function to convert any input type to std::string
134 inline std::string ConvToStr(char in)
136 return std::string(1, in);
139 /** Template function to convert any input type to std::string
141 template <class T> inline std::string ConvToStr(const T &in)
143 std::stringstream tmp;
144 if (!(tmp << in)) return std::string();
148 /** Template function to convert any input type to any other type
149 * (usually an integer or numeric type)
151 template<typename T> inline long ConvToInt(const T &in)
153 std::stringstream tmp;
154 if (!(tmp << in)) return 0;
155 return atol(tmp.str().c_str());
158 /** This class contains various STATS counters
159 * It is used by the InspIRCd class, which internally
160 * has an instance of it.
165 /** Number of accepted connections
167 unsigned long statsAccept;
168 /** Number of failed accepts
170 unsigned long statsRefused;
171 /** Number of unknown commands seen
173 unsigned long statsUnknown;
174 /** Number of nickname collisions handled
176 unsigned long statsCollisions;
177 /** Number of DNS queries sent out
179 unsigned long statsDns;
180 /** Number of good DNS replies received
181 * NOTE: This may not tally to the number sent out,
182 * due to timeouts and other latency issues.
184 unsigned long statsDnsGood;
185 /** Number of bad (negative) DNS replies received
186 * NOTE: This may not tally to the number sent out,
187 * due to timeouts and other latency issues.
189 unsigned long statsDnsBad;
190 /** Number of inbound connections seen
192 unsigned long statsConnects;
193 /** Total bytes of data transmitted
195 unsigned long statsSent;
196 /** Total bytes of data received
198 unsigned long statsRecv;
200 /** Cpu usage at last sample
203 /** Time QP sample was read
205 LARGE_INTEGER LastSampled;
208 LARGE_INTEGER QPFrequency;
210 /** Cpu usage at last sample
213 /** Time last sample was read
215 timespec LastSampled;
217 /** The constructor initializes all the counts to zero
220 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
221 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
226 /** This class manages the generation and transmission of ISUPPORT. */
227 class CoreExport ISupportManager
230 /** The generated lines which are sent to clients. */
231 std::vector<std::string> Lines;
234 /** (Re)build the ISUPPORT vector. */
237 /** Returns the std::vector of ISUPPORT lines. */
238 const std::vector<std::string>& GetLines()
243 /** Send the 005 numerics (ISUPPORT) to a user. */
244 void SendTo(LocalUser* user);
247 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
248 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
249 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
250 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
251 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
253 /** The main class of the irc server.
254 * This class contains instances of all the other classes in this software.
255 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
256 * object, and a list of active Module objects, and facilities for Module
257 * objects to interact with the core system it implements.
259 class CoreExport InspIRCd
262 /** Set up the signal handlers
266 /** Daemonize the ircd and close standard input/output streams
267 * @return True if the program daemonized succesfully
271 /** The current time, updated in the mainloop
273 struct timespec TIME;
275 /** A 64k buffer used to read socket data into
276 * NOTE: update ValidateNetBufferSize if you change this
278 char ReadBuffer[65535];
280 /** Check we aren't running as root, and exit if we are
281 * with exit code EXIT_STATUS_ROOT.
289 /** Global cull list, will be processed on next iteration
291 CullList GlobalCulls;
292 /** Actions that must happen outside of the current call stack */
293 ActionList AtomicActions;
297 IsNickHandler HandleIsNick;
298 IsIdentHandler HandleIsIdent;
299 OnCheckExemptionHandler HandleOnCheckExemption;
300 IsChannelHandler HandleIsChannel;
301 GenRandomHandler HandleGenRandom;
303 /** 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
306 * SendMode expects a User* to send the numeric replies
307 * back to, so we create it a fake user that isnt in the user
308 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
309 * falls into the abyss :p
311 FakeUser* FakeClient;
313 /** Find a user in the UUID hash
314 * @param uid The UUID to find
315 * @return A pointer to the user, or NULL if the user does not exist
317 User* FindUUID(const std::string &uid);
319 /** Time this ircd was booted
323 /** Config file pathname specified on the commandline or via ./configure
325 std::string ConfigFileName;
327 ExtensionManager Extensions;
329 /** Mode handler, handles mode setting and removal
333 /** Command parser, handles client to server commands
335 CommandParser* Parser;
337 /** Thread engine, Handles threading where required
339 ThreadEngine* Threads;
341 /** The thread/class used to read config files in REHASH and on startup
343 ConfigReaderThread* ConfigThread;
345 /** LogManager handles logging.
349 /** ModuleManager contains everything related to loading/unloading
352 ModuleManager* Modules;
354 /** BanCacheManager is used to speed up checking of restrictions on connection
357 BanCacheManager *BanCache;
359 /** Stats class, holds miscellaneous stats counters
363 /** Server Config class, holds configuration file data
365 ServerConfig* Config;
367 /** Snomask manager - handles routing of snomask messages
372 /** Timer manager class, triggers Timer timer events
374 TimerManager* Timers;
376 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
378 XLineManager* XLines;
380 /** User manager. Various methods and data associated with users.
384 /** Channel list, a hash_map containing all channels XXX move to channel manager class
388 /** List of the open ports
390 std::vector<ListenSocket*> ports;
392 /** Set to the current signal recieved
394 static sig_atomic_t s_signal;
396 /** Protocol interface, overridden by server protocol modules
398 ProtocolInterface* PI;
400 /** Holds extensible for user operquit
402 StringExtItem OperQuit;
404 /** Manages the generation and transmission of ISUPPORT. */
405 ISupportManager ISupport;
407 /** Get the current time
408 * Because this only calls time() once every time around the mainloop,
409 * it is much faster than calling time() directly.
410 * @return The current time as an epoch value (time_t)
412 inline time_t Time() { return TIME.tv_sec; }
413 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
414 inline long Time_ns() { return TIME.tv_nsec; }
415 /** Update the current time. Don't call this unless you have reason to do so. */
418 /** Generate a random string with the given length
419 * @param length The length in bytes
420 * @param printable if false, the string will use characters 0-255; otherwise,
421 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
423 std::string GenRandomStr(int length, bool printable = true);
424 /** Generate a random integer.
425 * This is generally more secure than rand()
427 unsigned long GenRandomInt(unsigned long max);
429 /** Fill a buffer with random bits */
430 caller2<void, char*, size_t> GenRandom;
432 /** Bind all ports specified in the configuration file.
433 * @return The number of ports bound without error
435 int BindPorts(FailedPortList &failed_ports);
437 /** Binds a socket on an already open file descriptor
438 * @param sockfd A valid file descriptor of an open socket
439 * @param port The port number to bind to
440 * @param addr The address to bind to (IP only)
441 * @param dolisten Should this port be listened on?
442 * @return True if the port was bound successfully
444 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
446 /** Find a user in the nick hash.
447 * If the user cant be found in the nick hash check the uuid hash
448 * @param nick The nickname to find
449 * @return A pointer to the user, or NULL if the user does not exist
451 User* FindNick(const std::string &nick);
453 /** Find a user in the nick hash ONLY
455 User* FindNickOnly(const std::string &nick);
457 /** Find a channel in the channels hash
458 * @param chan The channel to find
459 * @return A pointer to the channel, or NULL if the channel does not exist
461 Channel* FindChan(const std::string &chan);
463 /** Return true if a channel name is valid
464 * @param chname A channel name to verify
465 * @return True if the name is valid
467 caller1<bool, const std::string&> IsChannel;
469 /** Return true if str looks like a server ID
470 * @param sid string to check against
472 static bool IsSID(const std::string& sid);
474 /** Handles incoming signals after being set
475 * @param signal the signal recieved
477 void SignalHandler(int signal);
479 /** Sets the signal recieved
480 * @param signal the signal recieved
482 static void SetSignal(int signal);
484 /** Causes the server to exit after unloading modules and
485 * closing all open file descriptors.
487 * @param status The exit code to give to the operating system
488 * (See the ExitStatus enum for valid values)
490 void Exit(int status);
492 /** Causes the server to exit immediately with exit code 0.
493 * The status code is required for signal handlers, and ignored.
495 static void QuickExit(int status);
497 /** Formats the input string with the specified arguments.
498 * @param formatString The string to format
499 * @param ... A variable number of format arguments.
500 * @return The formatted string
502 static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
503 static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
505 /** Return a count of channels on the network
506 * @return The number of channels
508 long ChannelCount() const { return chanlist->size(); }
510 /** Send an error notice to all local users, opered and unopered
511 * @param s The error string to send
513 void SendError(const std::string &s);
515 /** Return true if a nickname is valid
516 * @param n A nickname to verify
517 * @return True if the nick is valid
519 caller1<bool, const std::string&> IsNick;
521 /** Return true if an ident is valid
522 * @param An ident to verify
523 * @return True if the ident is valid
525 caller1<bool, const std::string&> IsIdent;
527 /** Match two strings using pattern matching, optionally, with a map
528 * to check case against (may be NULL). If map is null, match will be case insensitive.
529 * @param str The literal string to match against
530 * @param mask The glob pattern to match against.
531 * @param map The character map to use when matching.
533 static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
534 static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
536 /** Match two strings using pattern matching, optionally, with a map
537 * to check case against (may be NULL). If map is null, match will be case insensitive.
538 * Supports CIDR patterns as well as globs.
539 * @param str The literal string to match against
540 * @param mask The glob or CIDR pattern to match against.
541 * @param map The character map to use when matching.
543 static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
544 static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
546 /** Matches a hostname and IP against a space delimited list of hostmasks.
547 * @param masks The space delimited masks to match against.
548 * @param hostname The hostname to try and match.
549 * @param ipaddr The IP address to try and match.
551 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
553 /** Return true if the given parameter is a valid nick!user\@host mask
554 * @param mask A nick!user\@host masak to match against
555 * @return True i the mask is valid
557 static bool IsValidMask(const std::string& mask);
559 /** Strips all color codes from the given string
560 * @param sentence The string to strip from
562 static void StripColor(std::string &sentence);
564 /** Parses color codes from string values to actual color codes
565 * @param input The data to process
567 static void ProcessColors(file_cache& input);
569 /** Rehash the local server
570 * @param uuid The uuid of the user who started the rehash, can be empty
572 void Rehash(const std::string& uuid = "");
574 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
575 * @param str A string containing a time in the form 1y2w3d4h6m5s
576 * (one year, two weeks, three days, four hours, six minutes and five seconds)
577 * @return The total number of seconds
579 static unsigned long Duration(const std::string& str);
581 /** Attempt to compare a password to a string from the config file.
582 * This will be passed to handling modules which will compare the data
583 * against possible hashed equivalents in the input string.
584 * @param ex The object (user, server, whatever) causing the comparison.
585 * @param data The data from the config file
586 * @param input The data input by the oper
587 * @param hashtype The hash from the config file
588 * @return True if the strings match, false if they do not
590 bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
592 /** Returns the full version string of this ircd
593 * @return The version string
595 std::string GetVersionString(bool getFullVersion = false);
597 /** Attempt to write the process id to a given file
598 * @param filename The PID file to attempt to write to
599 * @return This function may bail if the file cannot be written
601 void WritePID(const std::string &filename);
603 /** This constructor initialises all the subsystems and reads the config file.
604 * @param argc The argument count passed to main()
605 * @param argv The argument list passed to main()
606 * @throw <anything> If anything is thrown from here and makes it to
607 * you, you should probably just give up and go home. Yes, really.
608 * It's that bad. Higher level classes should catch any non-fatal exceptions.
610 InspIRCd(int argc, char** argv);
612 /** Send a line of WHOIS data to a user.
613 * @param user user to send the line to
614 * @param dest user being WHOISed
615 * @param numeric Numeric to send
616 * @param text Text of the numeric
618 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
620 /** Send a line of WHOIS data to a user.
621 * @param user user to send the line to
622 * @param dest user being WHOISed
623 * @param numeric Numeric to send
624 * @param format Format string for the numeric
625 * @param ... Parameters for the format string
627 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
629 /** Called to check whether a channel restriction mode applies to a user
630 * @param User that is attempting some action
631 * @param Channel that the action is being performed on
634 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
636 /** Prepare the ircd for restart or shutdown.
637 * This function unloads all modules which can be unloaded,
638 * closes all open sockets, and closes the logfile.
642 /** Return a time_t as a human-readable string.
644 static std::string TimeString(time_t curtime);
646 /** Begin execution of the server.
647 * NOTE: this function NEVER returns. Internally,
648 * it will repeatedly loop.
652 char* GetReadBuffer()
654 return this->ReadBuffer;
661 class CommandModule : public Module
665 CommandModule() : cmd(this)
671 return Version(cmd.name, VF_VENDOR|VF_CORE);