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 #define _FILE_OFFSET_BITS 64
29 #ifndef _LARGEFILE_SOURCE
30 #define _LARGEFILE_SOURCE
37 #include "inspircd_win32wrapper.h"
38 /** Windows defines these already */
43 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
45 #define CUSTOM_PRINTF(STRING, FIRST)
48 #if defined __clang__ || defined __GNUC__
49 # define DEPRECATED_METHOD(function) function __attribute__((deprecated))
50 #elif defined _MSC_VER
51 # define DEPRECATED_METHOD(function) __declspec(deprecated) function
53 # pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
54 # define DEPRECATED_METHOD(function) function
57 // Required system headers.
69 #if defined _LIBCPP_VERSION || defined _WIN32
71 # include <unordered_map>
73 # define TR1NS std::tr1
74 # include <tr1/unordered_map>
87 #include "consolecolors.h"
89 CoreExport extern InspIRCd* ServerInstance;
92 #include "cull_list.h"
93 #include "extensible.h"
101 #include "usermanager.h"
104 #include "command_parse.h"
106 #include "socketengine.h"
107 #include "snomasks.h"
108 #include "filelogger.h"
110 #include "threadengine.h"
111 #include "configreader.h"
112 #include "inspstring.h"
113 #include "protocol.h"
116 #warning Potentially broken system, PATH_MAX undefined
117 #define PATH_MAX 4096
121 * Used to define the maximum number of parameters a command may have.
123 #define MAXPARAMETERS 127
125 /** Returned by some functions to indicate failure.
129 /** Template function to convert any input type to std::string
131 template<typename T> inline std::string ConvNumeric(const T &in)
133 if (in == 0) return "0";
138 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
145 std::reverse(res,out);
149 /** Template function to convert any input type to std::string
151 inline std::string ConvToStr(const int in)
153 return ConvNumeric(in);
156 /** Template function to convert any input type to std::string
158 inline std::string ConvToStr(const long in)
160 return ConvNumeric(in);
163 /** Template function to convert any input type to std::string
165 inline std::string ConvToStr(const char* in)
170 /** Template function to convert any input type to std::string
172 inline std::string ConvToStr(const bool in)
174 return (in ? "1" : "0");
177 /** Template function to convert any input type to std::string
179 inline std::string ConvToStr(char in)
181 return std::string(in,1);
184 /** Template function to convert any input type to std::string
186 template <class T> inline std::string ConvToStr(const T &in)
188 std::stringstream tmp;
189 if (!(tmp << in)) return std::string();
193 /** Template function to convert any input type to any other type
194 * (usually an integer or numeric type)
196 template<typename T> inline long ConvToInt(const T &in)
198 std::stringstream tmp;
199 if (!(tmp << in)) return 0;
200 return atol(tmp.str().c_str());
203 /** This class contains various STATS counters
204 * It is used by the InspIRCd class, which internally
205 * has an instance of it.
210 /** Number of accepted connections
212 unsigned long statsAccept;
213 /** Number of failed accepts
215 unsigned long statsRefused;
216 /** Number of unknown commands seen
218 unsigned long statsUnknown;
219 /** Number of nickname collisions handled
221 unsigned long statsCollisions;
222 /** Number of DNS queries sent out
224 unsigned long statsDns;
225 /** Number of good DNS replies received
226 * NOTE: This may not tally to the number sent out,
227 * due to timeouts and other latency issues.
229 unsigned long statsDnsGood;
230 /** Number of bad (negative) DNS replies received
231 * NOTE: This may not tally to the number sent out,
232 * due to timeouts and other latency issues.
234 unsigned long statsDnsBad;
235 /** Number of inbound connections seen
237 unsigned long statsConnects;
238 /** Total bytes of data transmitted
240 unsigned long statsSent;
241 /** Total bytes of data received
243 unsigned long statsRecv;
245 /** Cpu usage at last sample
248 /** Time QP sample was read
250 LARGE_INTEGER LastSampled;
253 LARGE_INTEGER QPFrequency;
255 /** Cpu usage at last sample
258 /** Time last sample was read
260 timespec LastSampled;
262 /** The constructor initializes all the counts to zero
265 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
266 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
271 /** This class manages the generation and transmission of ISUPPORT. */
272 class CoreExport ISupportManager
275 /** The generated lines which are sent to clients. */
276 std::vector<std::string> Lines;
279 /** (Re)build the ISUPPORT vector. */
282 /** Returns the std::vector of ISUPPORT lines. */
283 const std::vector<std::string>& GetLines()
288 /** Send the 005 numerics (ISUPPORT) to a user. */
289 void SendTo(LocalUser* user);
292 DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
293 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
294 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
295 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
296 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
297 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
299 /** The main class of the irc server.
300 * This class contains instances of all the other classes in this software.
301 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
302 * object, and a list of active Module objects, and facilities for Module
303 * objects to interact with the core system it implements.
305 class CoreExport InspIRCd
308 /** Set up the signal handlers
312 /** Daemonize the ircd and close standard input/output streams
313 * @return True if the program daemonized succesfully
317 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
318 * @param TIME the current time
320 void DoSocketTimeouts(time_t TIME);
322 /** Perform background user events such as PING checks
324 void DoBackgroundUserStuff();
326 /** Returns true when all modules have done pre-registration checks on a user
327 * @param user The user to verify
328 * @return True if all modules have finished checking this user
330 bool AllModulesReportReady(LocalUser* user);
332 /** The current time, updated in the mainloop
334 struct timespec TIME;
336 /** A 64k buffer used to read socket data into
337 * NOTE: update ValidateNetBufferSize if you change this
339 char ReadBuffer[65535];
345 /** Global cull list, will be processed on next iteration
347 CullList GlobalCulls;
348 /** Actions that must happen outside of the current call stack */
349 ActionList AtomicActions;
353 IsNickHandler HandleIsNick;
354 IsIdentHandler HandleIsIdent;
355 OnCheckExemptionHandler HandleOnCheckExemption;
356 IsChannelHandler HandleIsChannel;
357 RehashHandler HandleRehash;
358 GenRandomHandler HandleGenRandom;
360 /** 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
363 * SendMode expects a User* to send the numeric replies
364 * back to, so we create it a fake user that isnt in the user
365 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
366 * falls into the abyss :p
368 FakeUser* FakeClient;
370 static const char LogHeader[];
372 /** Find a user in the UUID hash
373 * @param uid The UUID to find
374 * @return A pointer to the user, or NULL if the user does not exist
376 User* FindUUID(const std::string &uid);
378 /** Time this ircd was booted
382 /** Config file pathname specified on the commandline or via ./configure
384 std::string ConfigFileName;
386 ExtensionManager Extensions;
388 /** Mode handler, handles mode setting and removal
392 /** Command parser, handles client to server commands
394 CommandParser* Parser;
396 /** Socket engine, handles socket activity events
400 /** Thread engine, Handles threading where required
402 ThreadEngine* Threads;
404 /** The thread/class used to read config files in REHASH and on startup
406 ConfigReaderThread* ConfigThread;
408 /** LogManager handles logging.
412 /** ModuleManager contains everything related to loading/unloading
415 ModuleManager* Modules;
417 /** BanCacheManager is used to speed up checking of restrictions on connection
420 BanCacheManager *BanCache;
422 /** Stats class, holds miscellaneous stats counters
426 /** Server Config class, holds configuration file data
428 ServerConfig* Config;
430 /** Snomask manager - handles routing of snomask messages
435 /** Timer manager class, triggers Timer timer events
437 TimerManager* Timers;
439 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
441 XLineManager* XLines;
443 /** User manager. Various methods and data associated with users.
447 /** Channel list, a hash_map containing all channels XXX move to channel manager class
451 /** List of the open ports
453 std::vector<ListenSocket*> ports;
455 /** Set to the current signal recieved
459 /** Protocol interface, overridden by server protocol modules
461 ProtocolInterface* PI;
463 /** Holds extensible for user nickforced
465 LocalIntExt NICKForced;
467 /** Holds extensible for user operquit
469 LocalStringExt OperQuit;
471 /** Manages the generation and transmission of ISUPPORT. */
472 ISupportManager ISupport;
474 /** Get the current time
475 * Because this only calls time() once every time around the mainloop,
476 * it is much faster than calling time() directly.
477 * @return The current time as an epoch value (time_t)
479 inline time_t Time() { return TIME.tv_sec; }
480 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
481 inline long Time_ns() { return TIME.tv_nsec; }
482 /** Update the current time. Don't call this unless you have reason to do so. */
485 /** Generate a random string with the given length
486 * @param length The length in bytes
487 * @param printable if false, the string will use characters 0-255; otherwise,
488 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
490 std::string GenRandomStr(int length, bool printable = true);
491 /** Generate a random integer.
492 * This is generally more secure than rand()
494 unsigned long GenRandomInt(unsigned long max);
496 /** Fill a buffer with random bits */
497 caller2<void, char*, size_t> GenRandom;
499 /** Bind all ports specified in the configuration file.
500 * @return The number of ports bound without error
502 int BindPorts(FailedPortList &failed_ports);
504 /** Binds a socket on an already open file descriptor
505 * @param sockfd A valid file descriptor of an open socket
506 * @param port The port number to bind to
507 * @param addr The address to bind to (IP only)
508 * @param dolisten Should this port be listened on?
509 * @return True if the port was bound successfully
511 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
513 /** Gets the GECOS (description) field of the given server.
514 * If the servername is not that of the local server, the name
515 * is passed to handling modules which will attempt to determine
516 * the GECOS that bleongs to the given servername.
517 * @param servername The servername to find the description of
518 * @return The description of this server, or of the local server
520 std::string GetServerDescription(const std::string& servername);
522 /** Find a user in the nick hash.
523 * If the user cant be found in the nick hash check the uuid hash
524 * @param nick The nickname to find
525 * @return A pointer to the user, or NULL if the user does not exist
527 User* FindNick(const std::string &nick);
529 /** Find a user in the nick hash ONLY
531 User* FindNickOnly(const std::string &nick);
533 /** Find a channel in the channels hash
534 * @param chan The channel to find
535 * @return A pointer to the channel, or NULL if the channel does not exist
537 Channel* FindChan(const std::string &chan);
539 /** Check we aren't running as root, and exit if we are
540 * @return Depending on the configuration, this function may never return
544 /** Determine the right path for, and open, the logfile
545 * @param argv The argv passed to main() initially, used to calculate program path
546 * @param argc The argc passed to main() initially, used to calculate program path
547 * @return True if the log could be opened, false if otherwise
549 bool OpenLog(char** argv, int argc);
551 /** Return true if a channel name is valid
552 * @param chname A channel name to verify
553 * @return True if the name is valid
555 caller2<bool, const std::string&, size_t> IsChannel;
557 /** Return true if str looks like a server ID
558 * @param string to check against
560 static bool IsSID(const std::string& sid);
562 /** Rehash the local server
564 caller1<void, const std::string&> Rehash;
566 /** Handles incoming signals after being set
567 * @param signal the signal recieved
569 void SignalHandler(int signal);
571 /** Sets the signal recieved
572 * @param signal the signal recieved
574 static void SetSignal(int signal);
576 /** Causes the server to exit after unloading modules and
577 * closing all open file descriptors.
579 * @param status The exit code to give to the operating system
580 * (See the ExitStatus enum for valid values)
582 void Exit(int status);
584 /** Causes the server to exit immediately with exit code 0.
585 * The status code is required for signal handlers, and ignored.
587 static void QuickExit(int status);
589 /** Return a count of channels on the network
590 * @return The number of channels
594 /** Send an error notice to all local users, opered and unopered
595 * @param s The error string to send
597 void SendError(const std::string &s);
599 /** Return true if a nickname is valid
600 * @param n A nickname to verify
601 * @return True if the nick is valid
603 caller2<bool, const std::string&, size_t> IsNick;
605 /** Return true if an ident is valid
606 * @param An ident to verify
607 * @return True if the ident is valid
609 caller1<bool, const std::string&> IsIdent;
611 /** Add a command to this server's command parser
612 * @param f A Command command handler object to add
613 * @throw ModuleException Will throw ModuleExcption if the command already exists
615 inline void AddCommand(Command *f)
617 Modules->AddService(*f);
620 /** Send a modechange.
621 * The parameters provided are identical to that sent to the
622 * handler for class cmd_mode.
623 * @param parameters The mode parameters
624 * @param user The user to send error messages to
626 void SendMode(const std::vector<std::string>& parameters, User *user);
628 /** Send a modechange and route it to the network.
629 * The parameters provided are identical to that sent to the
630 * handler for class cmd_mode.
631 * @param parameters The mode parameters
632 * @param user The user to send error messages to
634 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
636 /** Match two strings using pattern matching, optionally, with a map
637 * to check case against (may be NULL). If map is null, match will be case insensitive.
638 * @param str The literal string to match against
639 * @param mask The glob pattern to match against.
640 * @param map The character map to use when matching.
642 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
643 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
645 /** Match two strings using pattern matching, optionally, with a map
646 * to check case against (may be NULL). If map is null, match will be case insensitive.
647 * Supports CIDR patterns as well as globs.
648 * @param str The literal string to match against
649 * @param mask The glob or CIDR pattern to match against.
650 * @param map The character map to use when matching.
652 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
653 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
655 /** Return true if the given parameter is a valid nick!user\@host mask
656 * @param mask A nick!user\@host masak to match against
657 * @return True i the mask is valid
659 bool IsValidMask(const std::string &mask);
661 /** Strips all color codes from the given string
662 * @param sentence The string to strip from
664 static void StripColor(std::string &sentence);
666 /** Parses color codes from string values to actual color codes
667 * @param input The data to process
669 static void ProcessColors(file_cache& input);
671 /** Rehash the local server
675 /** Check if the given nickmask matches too many users, send errors to the given user
676 * @param nick A nickmask to match against
677 * @param user A user to send error text to
678 * @return True if the nick matches too many users
680 bool NickMatchesEveryone(const std::string &nick, User* user);
682 /** Check if the given IP mask matches too many users, send errors to the given user
683 * @param ip An ipmask to match against
684 * @param user A user to send error text to
685 * @return True if the ip matches too many users
687 bool IPMatchesEveryone(const std::string &ip, User* user);
689 /** Check if the given hostmask matches too many users, send errors to the given user
690 * @param mask A hostmask to match against
691 * @param user A user to send error text to
692 * @return True if the host matches too many users
694 bool HostMatchesEveryone(const std::string &mask, User* user);
696 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
697 * @param str A string containing a time in the form 1y2w3d4h6m5s
698 * (one year, two weeks, three days, four hours, six minutes and five seconds)
699 * @return The total number of seconds
701 static unsigned long Duration(const std::string& str);
703 /** Attempt to compare a password to a string from the config file.
704 * This will be passed to handling modules which will compare the data
705 * against possible hashed equivalents in the input string.
706 * @param ex The object (user, server, whatever) causing the comparison.
707 * @param data The data from the config file
708 * @param input The data input by the oper
709 * @param hashtype The hash from the config file
710 * @return 0 if the strings match, 1 or -1 if they do not
712 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
714 /** Check if a given server is a uline.
715 * An empty string returns true, this is by design.
716 * @param server The server to check for uline status
717 * @return True if the server is a uline OR the string is empty
719 bool ULine(const std::string& server);
721 /** Returns true if the uline is 'silent' (doesnt generate
722 * remote connect notices etc).
724 bool SilentULine(const std::string& server);
726 /** Returns the full version string of this ircd
727 * @return The version string
729 std::string GetVersionString(bool rawversion = false);
731 /** Attempt to write the process id to a given file
732 * @param filename The PID file to attempt to write to
733 * @return This function may bail if the file cannot be written
735 void WritePID(const std::string &filename);
737 /** This constructor initialises all the subsystems and reads the config file.
738 * @param argc The argument count passed to main()
739 * @param argv The argument list passed to main()
740 * @throw <anything> If anything is thrown from here and makes it to
741 * you, you should probably just give up and go home. Yes, really.
742 * It's that bad. Higher level classes should catch any non-fatal exceptions.
744 InspIRCd(int argc, char** argv);
746 /** Send a line of WHOIS data to a user.
747 * @param user user to send the line to
748 * @param dest user being WHOISed
749 * @param numeric Numeric to send
750 * @param text Text of the numeric
752 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
754 /** Send a line of WHOIS data to a user.
755 * @param user user to send the line to
756 * @param dest user being WHOISed
757 * @param numeric Numeric to send
758 * @param format Format string for the numeric
759 * @param ... Parameters for the format string
761 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
763 /** Called to check whether a channel restriction mode applies to a user
764 * @param User that is attempting some action
765 * @param Channel that the action is being performed on
768 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
770 /** Restart the server.
771 * This function will not return. If an error occurs,
772 * it will throw an instance of CoreException.
773 * @param reason The restart reason to show to all clients
774 * @throw CoreException An instance of CoreException indicating the error from execv().
776 void Restart(const std::string &reason);
778 /** Prepare the ircd for restart or shutdown.
779 * This function unloads all modules which can be unloaded,
780 * closes all open sockets, and closes the logfile.
784 /** Return a time_t as a human-readable string.
786 std::string TimeString(time_t curtime);
788 /** Begin execution of the server.
789 * NOTE: this function NEVER returns. Internally,
790 * it will repeatedly loop.
791 * @return The return value for this function is undefined.
795 char* GetReadBuffer()
797 return this->ReadBuffer;
804 class CommandModule : public Module
808 CommandModule() : cmd(this)
814 ServerInstance->Modules->AddService(cmd);
819 return Version(cmd.name, VF_VENDOR|VF_CORE);