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/>.
49 CoreExport extern InspIRCd* ServerInstance;
52 #include "consolecolors.h"
54 #include "cull_list.h"
55 #include "extensible.h"
63 #include "usermanager.h"
66 #include "command_parse.h"
68 #include "socketengine.h"
70 #include "filelogger.h"
72 #include "threadengine.h"
73 #include "configreader.h"
74 #include "inspstring.h"
78 * Used to define the maximum number of parameters a command may have.
80 #define MAXPARAMETERS 127
82 /** Returned by some functions to indicate failure.
86 /** Template function to convert any input type to std::string
88 template<typename T> inline std::string ConvNumeric(const T &in)
90 if (in == 0) return "0";
95 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
102 std::reverse(res,out);
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(in,1);
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 /** This class contains various STATS counters
161 * It is used by the InspIRCd class, which internally
162 * has an instance of it.
167 /** Number of accepted connections
169 unsigned long statsAccept;
170 /** Number of failed accepts
172 unsigned long statsRefused;
173 /** Number of unknown commands seen
175 unsigned long statsUnknown;
176 /** Number of nickname collisions handled
178 unsigned long statsCollisions;
179 /** Number of DNS queries sent out
181 unsigned long statsDns;
182 /** Number of good DNS replies received
183 * NOTE: This may not tally to the number sent out,
184 * due to timeouts and other latency issues.
186 unsigned long statsDnsGood;
187 /** Number of bad (negative) DNS replies received
188 * NOTE: This may not tally to the number sent out,
189 * due to timeouts and other latency issues.
191 unsigned long statsDnsBad;
192 /** Number of inbound connections seen
194 unsigned long statsConnects;
195 /** Total bytes of data transmitted
197 unsigned long statsSent;
198 /** Total bytes of data received
200 unsigned long statsRecv;
202 /** Cpu usage at last sample
205 /** Time QP sample was read
207 LARGE_INTEGER LastSampled;
210 LARGE_INTEGER QPFrequency;
212 /** Cpu usage at last sample
215 /** Time last sample was read
217 timespec LastSampled;
219 /** The constructor initializes all the counts to zero
222 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
223 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
228 /** This class manages the generation and transmission of ISUPPORT. */
229 class CoreExport ISupportManager
232 /** The generated lines which are sent to clients. */
233 std::vector<std::string> Lines;
236 /** (Re)build the ISUPPORT vector. */
239 /** Returns the std::vector of ISUPPORT lines. */
240 const std::vector<std::string>& GetLines()
245 /** Send the 005 numerics (ISUPPORT) to a user. */
246 void SendTo(LocalUser* user);
249 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
250 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
251 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
252 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
253 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
254 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
256 /** The main class of the irc server.
257 * This class contains instances of all the other classes in this software.
258 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
259 * object, and a list of active Module objects, and facilities for Module
260 * objects to interact with the core system it implements.
262 class CoreExport InspIRCd
265 /** Set up the signal handlers
269 /** Daemonize the ircd and close standard input/output streams
270 * @return True if the program daemonized succesfully
274 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
275 * @param TIME the current time
277 void DoSocketTimeouts(time_t TIME);
279 /** Perform background user events such as PING checks
281 void DoBackgroundUserStuff();
283 /** Returns true when all modules have done pre-registration checks on a user
284 * @param user The user to verify
285 * @return True if all modules have finished checking this user
287 bool AllModulesReportReady(LocalUser* user);
289 /** The current time, updated in the mainloop
291 struct timespec TIME;
293 /** A 64k buffer used to read socket data into
294 * NOTE: update ValidateNetBufferSize if you change this
296 char ReadBuffer[65535];
302 /** Global cull list, will be processed on next iteration
304 CullList GlobalCulls;
305 /** Actions that must happen outside of the current call stack */
306 ActionList AtomicActions;
310 IsNickHandler HandleIsNick;
311 IsIdentHandler HandleIsIdent;
312 OnCheckExemptionHandler HandleOnCheckExemption;
313 IsChannelHandler HandleIsChannel;
314 RehashHandler HandleRehash;
315 GenRandomHandler HandleGenRandom;
317 /** 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
320 * SendMode expects a User* to send the numeric replies
321 * back to, so we create it a fake user that isnt in the user
322 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
323 * falls into the abyss :p
325 FakeUser* FakeClient;
327 static const char LogHeader[];
329 /** Find a user in the UUID hash
330 * @param uid The UUID to find
331 * @return A pointer to the user, or NULL if the user does not exist
333 User* FindUUID(const std::string &uid);
335 /** Time this ircd was booted
339 /** Config file pathname specified on the commandline or via ./configure
341 std::string ConfigFileName;
343 ExtensionManager Extensions;
345 /** Mode handler, handles mode setting and removal
349 /** Command parser, handles client to server commands
351 CommandParser* Parser;
353 /** Socket engine, handles socket activity events
357 /** Thread engine, Handles threading where required
359 ThreadEngine* Threads;
361 /** The thread/class used to read config files in REHASH and on startup
363 ConfigReaderThread* ConfigThread;
365 /** LogManager handles logging.
369 /** ModuleManager contains everything related to loading/unloading
372 ModuleManager* Modules;
374 /** BanCacheManager is used to speed up checking of restrictions on connection
377 BanCacheManager *BanCache;
379 /** Stats class, holds miscellaneous stats counters
383 /** Server Config class, holds configuration file data
385 ServerConfig* Config;
387 /** Snomask manager - handles routing of snomask messages
392 /** Timer manager class, triggers Timer timer events
394 TimerManager* Timers;
396 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
398 XLineManager* XLines;
400 /** User manager. Various methods and data associated with users.
404 /** Channel list, a hash_map containing all channels XXX move to channel manager class
408 /** List of the open ports
410 std::vector<ListenSocket*> ports;
412 /** Set to the current signal recieved
414 static sig_atomic_t s_signal;
416 /** Protocol interface, overridden by server protocol modules
418 ProtocolInterface* PI;
420 /** Holds extensible for user operquit
422 LocalStringExt OperQuit;
424 /** Manages the generation and transmission of ISUPPORT. */
425 ISupportManager ISupport;
427 /** Get the current time
428 * Because this only calls time() once every time around the mainloop,
429 * it is much faster than calling time() directly.
430 * @return The current time as an epoch value (time_t)
432 inline time_t Time() { return TIME.tv_sec; }
433 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
434 inline long Time_ns() { return TIME.tv_nsec; }
435 /** Update the current time. Don't call this unless you have reason to do so. */
438 /** Generate a random string with the given length
439 * @param length The length in bytes
440 * @param printable if false, the string will use characters 0-255; otherwise,
441 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
443 std::string GenRandomStr(int length, bool printable = true);
444 /** Generate a random integer.
445 * This is generally more secure than rand()
447 unsigned long GenRandomInt(unsigned long max);
449 /** Fill a buffer with random bits */
450 caller2<void, char*, size_t> GenRandom;
452 /** Bind all ports specified in the configuration file.
453 * @return The number of ports bound without error
455 int BindPorts(FailedPortList &failed_ports);
457 /** Binds a socket on an already open file descriptor
458 * @param sockfd A valid file descriptor of an open socket
459 * @param port The port number to bind to
460 * @param addr The address to bind to (IP only)
461 * @param dolisten Should this port be listened on?
462 * @return True if the port was bound successfully
464 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
466 /** Gets the GECOS (description) field of the given server.
467 * If the servername is not that of the local server, the name
468 * is passed to handling modules which will attempt to determine
469 * the GECOS that bleongs to the given servername.
470 * @param servername The servername to find the description of
471 * @return The description of this server, or of the local server
473 std::string GetServerDescription(const std::string& servername);
475 /** Find a user in the nick hash.
476 * If the user cant be found in the nick hash check the uuid hash
477 * @param nick The nickname to find
478 * @return A pointer to the user, or NULL if the user does not exist
480 User* FindNick(const std::string &nick);
482 /** Find a user in the nick hash ONLY
484 User* FindNickOnly(const std::string &nick);
486 /** Find a channel in the channels hash
487 * @param chan The channel to find
488 * @return A pointer to the channel, or NULL if the channel does not exist
490 Channel* FindChan(const std::string &chan);
492 /** Check we aren't running as root, and exit if we are
493 * @return Depending on the configuration, this function may never return
497 /** Determine the right path for, and open, the logfile
498 * @param argv The argv passed to main() initially, used to calculate program path
499 * @param argc The argc passed to main() initially, used to calculate program path
500 * @return True if the log could be opened, false if otherwise
502 bool OpenLog(char** argv, int argc);
504 /** Return true if a channel name is valid
505 * @param chname A channel name to verify
506 * @return True if the name is valid
508 caller1<bool, const std::string&> IsChannel;
510 /** Return true if str looks like a server ID
511 * @param string to check against
513 static bool IsSID(const std::string& sid);
515 /** Rehash the local server
517 caller1<void, const std::string&> Rehash;
519 /** Handles incoming signals after being set
520 * @param signal the signal recieved
522 void SignalHandler(int signal);
524 /** Sets the signal recieved
525 * @param signal the signal recieved
527 static void SetSignal(int signal);
529 /** Causes the server to exit after unloading modules and
530 * closing all open file descriptors.
532 * @param status The exit code to give to the operating system
533 * (See the ExitStatus enum for valid values)
535 void Exit(int status);
537 /** Causes the server to exit immediately with exit code 0.
538 * The status code is required for signal handlers, and ignored.
542 * @param How you want it formatted
544 * @return The formatted string
546 static const char* Format(const char* formatString, ...);
548 static void QuickExit(int status);
550 /** Return a count of channels on the network
551 * @return The number of channels
555 /** Send an error notice to all local users, opered and unopered
556 * @param s The error string to send
558 void SendError(const std::string &s);
560 /** Return true if a nickname is valid
561 * @param n A nickname to verify
562 * @return True if the nick is valid
564 caller1<bool, const std::string&> IsNick;
566 /** Return true if an ident is valid
567 * @param An ident to verify
568 * @return True if the ident is valid
570 caller1<bool, const std::string&> IsIdent;
572 /** Add a command to this server's command parser
573 * @param f A Command command handler object to add
574 * @throw ModuleException Will throw ModuleExcption if the command already exists
576 inline void AddCommand(Command *f)
578 Modules->AddService(*f);
581 /** Send a modechange.
582 * The parameters provided are identical to that sent to the
583 * handler for class cmd_mode.
584 * @param parameters The mode parameters
585 * @param user The user to send error messages to
587 void SendMode(const std::vector<std::string>& parameters, User *user);
589 /** Send a modechange and route it to the network.
590 * The parameters provided are identical to that sent to the
591 * handler for class cmd_mode.
592 * @param parameters The mode parameters
593 * @param user The user to send error messages to
595 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
597 /** Match two strings using pattern matching, optionally, with a map
598 * to check case against (may be NULL). If map is null, match will be case insensitive.
599 * @param str The literal string to match against
600 * @param mask The glob pattern to match against.
601 * @param map The character map to use when matching.
603 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
604 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
606 /** Match two strings using pattern matching, optionally, with a map
607 * to check case against (may be NULL). If map is null, match will be case insensitive.
608 * Supports CIDR patterns as well as globs.
609 * @param str The literal string to match against
610 * @param mask The glob or CIDR pattern to match against.
611 * @param map The character map to use when matching.
613 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
614 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
616 /** Matches a hostname and IP against a space delimited list of hostmasks.
617 * @param masks The space delimited masks to match against.
618 * @param hostname The hostname to try and match.
619 * @param ipaddr The IP address to try and match.
621 static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
623 /** Return true if the given parameter is a valid nick!user\@host mask
624 * @param mask A nick!user\@host masak to match against
625 * @return True i the mask is valid
627 bool IsValidMask(const std::string &mask);
629 /** Strips all color codes from the given string
630 * @param sentence The string to strip from
632 static void StripColor(std::string &sentence);
634 /** Parses color codes from string values to actual color codes
635 * @param input The data to process
637 static void ProcessColors(file_cache& input);
639 /** Rehash the local server
643 /** Check if the given nickmask matches too many users, send errors to the given user
644 * @param nick A nickmask to match against
645 * @param user A user to send error text to
646 * @return True if the nick matches too many users
648 bool NickMatchesEveryone(const std::string &nick, User* user);
650 /** Check if the given IP mask matches too many users, send errors to the given user
651 * @param ip An ipmask to match against
652 * @param user A user to send error text to
653 * @return True if the ip matches too many users
655 bool IPMatchesEveryone(const std::string &ip, User* user);
657 /** Check if the given hostmask matches too many users, send errors to the given user
658 * @param mask A hostmask to match against
659 * @param user A user to send error text to
660 * @return True if the host matches too many users
662 bool HostMatchesEveryone(const std::string &mask, User* user);
664 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
665 * @param str A string containing a time in the form 1y2w3d4h6m5s
666 * (one year, two weeks, three days, four hours, six minutes and five seconds)
667 * @return The total number of seconds
669 static unsigned long Duration(const std::string& str);
671 /** Attempt to compare a password to a string from the config file.
672 * This will be passed to handling modules which will compare the data
673 * against possible hashed equivalents in the input string.
674 * @param ex The object (user, server, whatever) causing the comparison.
675 * @param data The data from the config file
676 * @param input The data input by the oper
677 * @param hashtype The hash from the config file
678 * @return 0 if the strings match, 1 or -1 if they do not
680 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
682 /** Check if a given server is a uline.
683 * An empty string returns true, this is by design.
684 * @param server The server to check for uline status
685 * @return True if the server is a uline OR the string is empty
687 bool ULine(const std::string& server);
689 /** Returns true if the uline is 'silent' (doesnt generate
690 * remote connect notices etc).
692 bool SilentULine(const std::string& server);
694 /** Returns the full version string of this ircd
695 * @return The version string
697 std::string GetVersionString(bool getFullVersion = false);
699 /** Attempt to write the process id to a given file
700 * @param filename The PID file to attempt to write to
701 * @return This function may bail if the file cannot be written
703 void WritePID(const std::string &filename);
705 /** This constructor initialises all the subsystems and reads the config file.
706 * @param argc The argument count passed to main()
707 * @param argv The argument list passed to main()
708 * @throw <anything> If anything is thrown from here and makes it to
709 * you, you should probably just give up and go home. Yes, really.
710 * It's that bad. Higher level classes should catch any non-fatal exceptions.
712 InspIRCd(int argc, char** argv);
714 /** Send a line of WHOIS data to a user.
715 * @param user user to send the line to
716 * @param dest user being WHOISed
717 * @param numeric Numeric to send
718 * @param text Text of the numeric
720 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
722 /** Send a line of WHOIS data to a user.
723 * @param user user to send the line to
724 * @param dest user being WHOISed
725 * @param numeric Numeric to send
726 * @param format Format string for the numeric
727 * @param ... Parameters for the format string
729 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
731 /** Called to check whether a channel restriction mode applies to a user
732 * @param User that is attempting some action
733 * @param Channel that the action is being performed on
736 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
738 /** Restart the server.
739 * This function will not return. If an error occurs,
740 * it will throw an instance of CoreException.
741 * @param reason The restart reason to show to all clients
742 * @throw CoreException An instance of CoreException indicating the error from execv().
744 void Restart(const std::string &reason);
746 /** Prepare the ircd for restart or shutdown.
747 * This function unloads all modules which can be unloaded,
748 * closes all open sockets, and closes the logfile.
752 /** Return a time_t as a human-readable string.
754 std::string TimeString(time_t curtime);
756 /** Begin execution of the server.
757 * NOTE: this function NEVER returns. Internally,
758 * it will repeatedly loop.
759 * @return The return value for this function is undefined.
763 char* GetReadBuffer()
765 return this->ReadBuffer;
772 class CommandModule : public Module
776 CommandModule() : cmd(this)
782 ServerInstance->Modules->AddService(cmd);
787 return Version(cmd.name, VF_VENDOR|VF_CORE);