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/>.
29 #define _FILE_OFFSET_BITS 64
30 #ifndef _LARGEFILE_SOURCE
31 #define _LARGEFILE_SOURCE
37 #define printf_c printf
39 #include "inspircd_win32wrapper.h"
40 /** Windows defines these already */
45 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
47 #define CUSTOM_PRINTF(STRING, FIRST)
50 // Required system headers.
71 #include "inspircd_config.h"
72 #include "inspircd_version.h"
75 CoreExport extern InspIRCd* ServerInstance;
78 #include "cull_list.h"
79 #include "extensible.h"
87 #include "usermanager.h"
90 #include "command_parse.h"
92 #include "socketengine.h"
94 #include "filelogger.h"
96 #include "threadengine.h"
97 #include "configreader.h"
98 #include "inspstring.h"
102 #warning Potentially broken system, PATH_MAX undefined
103 #define PATH_MAX 4096
107 * Used to define the maximum number of parameters a command may have.
109 #define MAXPARAMETERS 127
111 /** Returned by some functions to indicate failure.
115 /** Support for librodent -
116 * see http://www.chatspike.net/index.php?z=64
118 #define ETIREDHAMSTERS EAGAIN
120 /** Template function to convert any input type to std::string
122 template<typename T> inline std::string ConvNumeric(const T &in)
124 if (in == 0) return "0";
129 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
136 std::reverse(res,out);
140 /** Template function to convert any input type to std::string
142 inline std::string ConvToStr(const int in)
144 return ConvNumeric(in);
147 /** Template function to convert any input type to std::string
149 inline std::string ConvToStr(const long in)
151 return ConvNumeric(in);
154 /** Template function to convert any input type to std::string
156 inline std::string ConvToStr(const char* in)
161 /** Template function to convert any input type to std::string
163 inline std::string ConvToStr(const bool in)
165 return (in ? "1" : "0");
168 /** Template function to convert any input type to std::string
170 inline std::string ConvToStr(char in)
172 return std::string(in,1);
175 /** Template function to convert any input type to std::string
177 template <class T> inline std::string ConvToStr(const T &in)
179 std::stringstream tmp;
180 if (!(tmp << in)) return std::string();
184 /** Template function to convert any input type to any other type
185 * (usually an integer or numeric type)
187 template<typename T> inline long ConvToInt(const T &in)
189 std::stringstream tmp;
190 if (!(tmp << in)) return 0;
191 return atol(tmp.str().c_str());
194 /** This class contains various STATS counters
195 * It is used by the InspIRCd class, which internally
196 * has an instance of it.
201 /** Number of accepted connections
203 unsigned long statsAccept;
204 /** Number of failed accepts
206 unsigned long statsRefused;
207 /** Number of unknown commands seen
209 unsigned long statsUnknown;
210 /** Number of nickname collisions handled
212 unsigned long statsCollisions;
213 /** Number of DNS queries sent out
215 unsigned long statsDns;
216 /** Number of good DNS replies received
217 * NOTE: This may not tally to the number sent out,
218 * due to timeouts and other latency issues.
220 unsigned long statsDnsGood;
221 /** Number of bad (negative) DNS replies received
222 * NOTE: This may not tally to the number sent out,
223 * due to timeouts and other latency issues.
225 unsigned long statsDnsBad;
226 /** Number of inbound connections seen
228 unsigned long statsConnects;
229 /** Total bytes of data transmitted
231 unsigned long statsSent;
232 /** Total bytes of data received
234 unsigned long statsRecv;
235 /** Cpu usage at last sample
238 /** Time last sample was read
240 timespec LastSampled;
241 /** The constructor initializes all the counts to zero
244 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
245 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
250 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
251 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
252 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
253 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
254 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
255 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
256 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
257 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
261 /** The main class of the irc server.
262 * This class contains instances of all the other classes in this software.
263 * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
264 * object, and a list of active Module objects, and facilities for Module
265 * objects to interact with the core system it implements.
267 class CoreExport InspIRCd
270 /** Holds the current UID. Used to generate the next one.
272 char current_uid[UUID_LENGTH];
274 /** Set up the signal handlers
278 /** Daemonize the ircd and close standard input/output streams
279 * @return True if the program daemonized succesfully
283 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
284 * @param TIME the current time
286 void DoSocketTimeouts(time_t TIME);
288 /** Increments the current UID by one.
290 void IncrementUID(int pos);
292 /** Perform background user events such as PING checks
294 void DoBackgroundUserStuff();
296 /** Returns true when all modules have done pre-registration checks on a user
297 * @param user The user to verify
298 * @return True if all modules have finished checking this user
300 bool AllModulesReportReady(LocalUser* user);
302 /** The current time, updated in the mainloop
304 struct timespec TIME;
306 /** A 64k buffer used to read socket data into
307 * NOTE: update ValidateNetBufferSize if you change this
309 char ReadBuffer[65535];
317 /** Global cull list, will be processed on next iteration
319 CullList GlobalCulls;
320 /** Actions that must happen outside of the current call stack */
321 ActionList AtomicActions;
325 IsNickHandler HandleIsNick;
326 IsIdentHandler HandleIsIdent;
327 FloodQuitUserHandler HandleFloodQuitUser;
328 OnCheckExemptionHandler HandleOnCheckExemption;
329 IsChannelHandler HandleIsChannel;
330 IsSIDHandler HandleIsSID;
331 RehashHandler HandleRehash;
332 GenRandomHandler HandleGenRandom;
334 /** 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
337 * SendMode expects a User* to send the numeric replies
338 * back to, so we create it a fake user that isnt in the user
339 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
340 * falls into the abyss :p
342 FakeUser* FakeClient;
344 /** Returns the next available UID for this server.
346 std::string GetUID();
348 static const char LogHeader[];
350 /** Find a user in the UUID hash
351 * @param uid The UUID to find
352 * @return A pointer to the user, or NULL if the user does not exist
354 User* FindUUID(const std::string &uid);
356 /** Find a user in the UUID hash
357 * @param uid The UUID to find
358 * @return A pointer to the user, or NULL if the user does not exist
360 User* FindUUID(const char *uid);
362 /** Build the ISUPPORT string by triggering all modules On005Numeric events
364 void BuildISupport();
366 /** Time this ircd was booted
370 /** Config file pathname specified on the commandline or via ./configure
372 std::string ConfigFileName;
374 ExtensionManager Extensions;
376 /** Mode handler, handles mode setting and removal
380 /** Command parser, handles client to server commands
382 CommandParser* Parser;
384 /** Socket engine, handles socket activity events
388 /** Thread engine, Handles threading where required
390 ThreadEngine* Threads;
392 /** The thread/class used to read config files in REHASH and on startup
394 ConfigReaderThread* ConfigThread;
396 /** LogManager handles logging.
400 /** ModuleManager contains everything related to loading/unloading
403 ModuleManager* Modules;
405 /** BanCacheManager is used to speed up checking of restrictions on connection
408 BanCacheManager *BanCache;
410 /** Stats class, holds miscellaneous stats counters
414 /** Server Config class, holds configuration file data
416 ServerConfig* Config;
418 /** Snomask manager - handles routing of snomask messages
423 /** DNS class, provides resolver facilities to the core and modules
427 /** Timer manager class, triggers Timer timer events
429 TimerManager* Timers;
431 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
433 XLineManager* XLines;
435 /** User manager. Various methods and data associated with users.
439 /** Channel list, a hash_map containing all channels XXX move to channel manager class
443 /** List of the open ports
445 std::vector<ListenSocket*> ports;
447 /** Set to the current signal recieved
451 /** Protocol interface, overridden by server protocol modules
453 ProtocolInterface* PI;
455 /** Holds extensible for user nickforced
457 LocalIntExt NICKForced;
459 /** Holds extensible for user operquit
461 LocalStringExt OperQuit;
463 /** Get the current time
464 * Because this only calls time() once every time around the mainloop,
465 * it is much faster than calling time() directly.
466 * @return The current time as an epoch value (time_t)
468 inline time_t Time() { return TIME.tv_sec; }
469 /** The fractional time at the start of this mainloop iteration (nanoseconds) */
470 inline long Time_ns() { return TIME.tv_nsec; }
471 /** Update the current time. Don't call this unless you have reason to do so. */
474 /** Generate a random string with the given length
475 * @param length The length in bytes
476 * @param printable if false, the string will use characters 0-255; otherwise,
477 * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
479 std::string GenRandomStr(int length, bool printable = true);
480 /** Generate a random integer.
481 * This is generally more secure than rand()
483 unsigned long GenRandomInt(unsigned long max);
485 /** Fill a buffer with random bits */
486 caller2<void, char*, size_t> GenRandom;
488 /** Bind all ports specified in the configuration file.
489 * @return The number of ports bound without error
491 int BindPorts(FailedPortList &failed_ports);
493 /** Binds a socket on an already open file descriptor
494 * @param sockfd A valid file descriptor of an open socket
495 * @param port The port number to bind to
496 * @param addr The address to bind to (IP only)
497 * @param dolisten Should this port be listened on?
498 * @return True if the port was bound successfully
500 bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
502 /** Gets the GECOS (description) field of the given server.
503 * If the servername is not that of the local server, the name
504 * is passed to handling modules which will attempt to determine
505 * the GECOS that bleongs to the given servername.
506 * @param servername The servername to find the description of
507 * @return The description of this server, or of the local server
509 std::string GetServerDescription(const std::string& servername);
511 /** Find a user in the nick hash.
512 * If the user cant be found in the nick hash check the uuid hash
513 * @param nick The nickname to find
514 * @return A pointer to the user, or NULL if the user does not exist
516 User* FindNick(const std::string &nick);
518 /** Find a user in the nick hash.
519 * If the user cant be found in the nick hash check the uuid hash
520 * @param nick The nickname to find
521 * @return A pointer to the user, or NULL if the user does not exist
523 User* FindNick(const char* nick);
525 /** Find a user in the nick hash ONLY
527 User* FindNickOnly(const char* 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 /** Find a channel in the channels hash
540 * @param chan The channel to find
541 * @return A pointer to the channel, or NULL if the channel does not exist
543 Channel* FindChan(const char* chan);
545 /** Check we aren't running as root, and exit if we are
546 * @return Depending on the configuration, this function may never return
550 /** Determine the right path for, and open, the logfile
551 * @param argv The argv passed to main() initially, used to calculate program path
552 * @param argc The argc passed to main() initially, used to calculate program path
553 * @return True if the log could be opened, false if otherwise
555 bool OpenLog(char** argv, int argc);
557 /** Return true if a channel name is valid
558 * @param chname A channel name to verify
559 * @return True if the name is valid
561 caller2<bool, const char*, size_t> IsChannel;
563 /** Return true if str looks like a server ID
564 * @param string to check against
566 caller1<bool, const std::string&> IsSID;
568 /** Rehash the local server
570 caller1<void, const std::string&> Rehash;
572 /** Handles incoming signals after being set
573 * @param signal the signal recieved
575 void SignalHandler(int signal);
577 /** Sets the signal recieved
578 * @param signal the signal recieved
580 static void SetSignal(int signal);
582 /** Causes the server to exit after unloading modules and
583 * closing all open file descriptors.
585 * @param status The exit code to give to the operating system
586 * (See the ExitStatus enum for valid values)
588 void Exit(int status);
590 /** Causes the server to exit immediately with exit code 0.
591 * The status code is required for signal handlers, and ignored.
593 static void QuickExit(int status);
595 /** Return a count of channels on the network
596 * @return The number of channels
600 /** Send an error notice to all local users, opered and unopered
601 * @param s The error string to send
603 void SendError(const std::string &s);
605 /** Return true if a nickname is valid
606 * @param n A nickname to verify
607 * @return True if the nick is valid
609 caller2<bool, const char*, size_t> IsNick;
611 /** Return true if an ident is valid
612 * @param An ident to verify
613 * @return True if the ident is valid
615 caller1<bool, const char*> IsIdent;
617 /** Add a dns Resolver class to this server's active set
618 * @param r The resolver to add
619 * @param cached If this value is true, then the cache will
620 * be searched for the DNS result, immediately. If the value is
621 * false, then a request will be sent to the nameserver, and the
622 * result will not be immediately available. You should usually
623 * use the boolean value which you passed to the Resolver
624 * constructor, which Resolver will set appropriately depending
625 * on if cached results are available and haven't expired. It is
626 * however safe to force this value to false, forcing a remote DNS
627 * lookup, but not an update of the cache.
628 * @return True if the operation completed successfully. Note that
629 * if this method returns true, you should not attempt to access
630 * the resolver class you pass it after this call, as depending upon
631 * the request given, the object may be deleted!
633 bool AddResolver(Resolver* r, bool cached);
635 /** Add a command to this server's command parser
636 * @param f A Command command handler object to add
637 * @throw ModuleException Will throw ModuleExcption if the command already exists
639 inline void AddCommand(Command *f)
641 Modules->AddService(*f);
644 /** Send a modechange.
645 * The parameters provided are identical to that sent to the
646 * handler for class cmd_mode.
647 * @param parameters The mode parameters
648 * @param user The user to send error messages to
650 void SendMode(const std::vector<std::string>& parameters, User *user);
652 /** Send a modechange and route it to the network.
653 * The parameters provided are identical to that sent to the
654 * handler for class cmd_mode.
655 * @param parameters The mode parameters
656 * @param user The user to send error messages to
658 void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
660 /** Match two strings using pattern matching, optionally, with a map
661 * to check case against (may be NULL). If map is null, match will be case insensitive.
662 * @param str The literal string to match against
663 * @param mask The glob pattern to match against.
664 * @param map The character map to use when matching.
666 static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
667 static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
669 /** Match two strings using pattern matching, optionally, with a map
670 * to check case against (may be NULL). If map is null, match will be case insensitive.
671 * Supports CIDR patterns as well as globs.
672 * @param str The literal string to match against
673 * @param mask The glob or CIDR pattern to match against.
674 * @param map The character map to use when matching.
676 static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
677 static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
679 /** Call the handler for a given command.
680 * @param commandname The command whos handler you wish to call
681 * @param parameters The mode parameters
682 * @param user The user to execute the command as
683 * @return True if the command handler was called successfully
685 CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
687 /** Return true if the command is a module-implemented command and the given parameters are valid for it
688 * @param commandname The command name to check
689 * @param pcnt The parameter count
690 * @param user The user to test-execute the command as
691 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
693 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
695 /** Return true if the given parameter is a valid nick!user\@host mask
696 * @param mask A nick!user\@host masak to match against
697 * @return True i the mask is valid
699 bool IsValidMask(const std::string &mask);
701 /** Rehash the local server
705 /** Check if the given nickmask matches too many users, send errors to the given user
706 * @param nick A nickmask to match against
707 * @param user A user to send error text to
708 * @return True if the nick matches too many users
710 bool NickMatchesEveryone(const std::string &nick, User* user);
712 /** Check if the given IP mask matches too many users, send errors to the given user
713 * @param ip An ipmask to match against
714 * @param user A user to send error text to
715 * @return True if the ip matches too many users
717 bool IPMatchesEveryone(const std::string &ip, User* user);
719 /** Check if the given hostmask matches too many users, send errors to the given user
720 * @param mask A hostmask to match against
721 * @param user A user to send error text to
722 * @return True if the host matches too many users
724 bool HostMatchesEveryone(const std::string &mask, User* user);
726 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
727 * @param str A string containing a time in the form 1y2w3d4h6m5s
728 * (one year, two weeks, three days, four hours, six minutes and five seconds)
729 * @return The total number of seconds
731 long Duration(const std::string &str);
733 /** Attempt to compare a password to a string from the config file.
734 * This will be passed to handling modules which will compare the data
735 * against possible hashed equivalents in the input string.
736 * @param ex The object (user, server, whatever) causing the comparison.
737 * @param data The data from the config file
738 * @param input The data input by the oper
739 * @param hashtype The hash from the config file
740 * @return 0 if the strings match, 1 or -1 if they do not
742 int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
744 /** Check if a given server is a uline.
745 * An empty string returns true, this is by design.
746 * @param server The server to check for uline status
747 * @return True if the server is a uline OR the string is empty
749 bool ULine(const std::string& server);
751 /** Returns true if the uline is 'silent' (doesnt generate
752 * remote connect notices etc).
754 bool SilentULine(const std::string& server);
756 /** Returns the full version string of this ircd
757 * @return The version string
759 std::string GetVersionString(bool rawversion = false);
761 /** Attempt to write the process id to a given file
762 * @param filename The PID file to attempt to write to
763 * @return This function may bail if the file cannot be written
765 void WritePID(const std::string &filename);
767 /** This constructor initialises all the subsystems and reads the config file.
768 * @param argc The argument count passed to main()
769 * @param argv The argument list passed to main()
770 * @throw <anything> If anything is thrown from here and makes it to
771 * you, you should probably just give up and go home. Yes, really.
772 * It's that bad. Higher level classes should catch any non-fatal exceptions.
774 InspIRCd(int argc, char** argv);
776 /** Send a line of WHOIS data to a user.
777 * @param user user to send the line to
778 * @param dest user being WHOISed
779 * @param numeric Numeric to send
780 * @param text Text of the numeric
782 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
784 /** Send a line of WHOIS data to a user.
785 * @param user user to send the line to
786 * @param dest user being WHOISed
787 * @param numeric Numeric to send
788 * @param format Format string for the numeric
789 * @param ... Parameters for the format string
791 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
795 void DoStats(char statschar, User* user, string_list &results);
799 void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
801 /** Quit a user for excess flood, and if they are not
802 * fully registered yet, temporarily zline their IP.
803 * @param current user to quit
805 caller1<void, User*> FloodQuitUser;
807 /** Called to check whether a channel restriction mode applies to a user
808 * @param User that is attempting some action
809 * @param Channel that the action is being performed on
812 caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
814 /** Restart the server.
815 * This function will not return. If an error occurs,
816 * it will throw an instance of CoreException.
817 * @param reason The restart reason to show to all clients
818 * @throw CoreException An instance of CoreException indicating the error from execv().
820 void Restart(const std::string &reason);
822 /** Prepare the ircd for restart or shutdown.
823 * This function unloads all modules which can be unloaded,
824 * closes all open sockets, and closes the logfile.
828 /** This copies the user and channel hash_maps into new hash maps.
829 * This frees memory used by the hash_map allocator (which it neglects
830 * to free, most of the time, using tons of ram)
832 void RehashUsersAndChans();
834 /** Resets the cached max bans value on all channels.
839 /** Return a time_t as a human-readable string.
841 std::string TimeString(time_t curtime);
843 /** Begin execution of the server.
844 * NOTE: this function NEVER returns. Internally,
845 * it will repeatedly loop.
846 * @return The return value for this function is undefined.
850 /** Adds an extban char to the 005 token.
852 void AddExtBanChar(char c);
854 char* GetReadBuffer()
856 return this->ReadBuffer;
859 friend class TestSuite;
865 class CommandModule : public Module
869 CommandModule() : cmd(this)
875 ServerInstance->Modules->AddService(cmd);
880 return Version(cmd.name, VF_VENDOR|VF_CORE);