X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=00093e52ba07fbbd33f0ef3d79fd87f7fd3b3fed;hb=f8a9b6ba4ae0b4b3c7b2a408332230dd82eb4608;hp=94b6cbafd47522889566c0d0de2d487485efc991;hpb=b071a6acd805bde6119a66481768be13102d1c2b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 94b6cbafd..00093e52b 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -25,6 +25,7 @@ #pragma once +#include #include #include #include @@ -32,6 +33,7 @@ #include #include #include +#include #include #include @@ -44,20 +46,35 @@ #include #include "intrusive_list.h" +#include "flat_map.h" #include "compat.h" +#include "aligned_storage.h" #include "typedefs.h" +#include "convto.h" #include "stdalgo.h" CoreExport extern InspIRCd* ServerInstance; +/** Base class for manager classes that are still accessed using -> but are no longer pointers + */ +template +struct fakederef +{ + T* operator->() + { + return static_cast(this); + } +}; + #include "config.h" #include "dynref.h" #include "consolecolors.h" -#include "caller.h" #include "cull_list.h" #include "extensible.h" #include "fileutils.h" +#include "ctables.h" #include "numerics.h" +#include "numeric.h" #include "uid.h" #include "server.h" #include "users.h" @@ -67,103 +84,19 @@ CoreExport extern InspIRCd* ServerInstance; #include "logger.h" #include "usermanager.h" #include "socket.h" -#include "ctables.h" #include "command_parse.h" #include "mode.h" #include "socketengine.h" #include "snomasks.h" #include "filelogger.h" +#include "message.h" #include "modules.h" #include "threadengine.h" #include "configreader.h" #include "inspstring.h" #include "protocol.h" - -/** Returned by some functions to indicate failure. - */ -#define ERROR -1 - -/** Template function to convert any input type to std::string - */ -template inline std::string ConvNumeric(const T &in) -{ - if (in == 0) - return "0"; - T quotient = in; - std::string out; - while (quotient) - { - out += "0123456789"[ std::abs( (long)quotient % 10 ) ]; - quotient /= 10; - } - if (in < 0) - out += '-'; - std::reverse(out.begin(), out.end()); - return out; -} - -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(const int in) -{ - return ConvNumeric(in); -} - -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(const long in) -{ - return ConvNumeric(in); -} - -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(const char* in) -{ - return in; -} - -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(const bool in) -{ - return (in ? "1" : "0"); -} - -/** Template function to convert any input type to std::string - */ -inline std::string ConvToStr(char in) -{ - return std::string(1, in); -} - -/** Template function to convert any input type to std::string - */ -template inline std::string ConvToStr(const T &in) -{ - std::stringstream tmp; - if (!(tmp << in)) return std::string(); - return tmp.str(); -} - -/** Template function to convert any input type to any other type - * (usually an integer or numeric type) - */ -template inline long ConvToInt(const T &in) -{ - std::stringstream tmp; - if (!(tmp << in)) return 0; - return atol(tmp.str().c_str()); -} - -inline uint64_t ConvToUInt64(const std::string& in) -{ - uint64_t ret; - std::istringstream tmp(in); - if (!(tmp >> ret)) - return 0; - return ret; -} +#include "bancache.h" +#include "isupportmanager.h" /** This class contains various STATS counters * It is used by the InspIRCd class, which internally @@ -233,33 +166,6 @@ class serverstats } }; -/** This class manages the generation and transmission of ISUPPORT. */ -class CoreExport ISupportManager -{ -private: - /** The generated lines which are sent to clients. */ - std::vector Lines; - -public: - /** (Re)build the ISUPPORT vector. */ - void Build(); - - /** Returns the std::vector of ISUPPORT lines. */ - const std::vector& GetLines() - { - return this->Lines; - } - - /** Send the 005 numerics (ISUPPORT) to a user. */ - void SendTo(LocalUser* user); -}; - -DEFINE_HANDLER1(IsNickHandler, bool, const std::string&); -DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t); -DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&); -DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&); -DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&); - /** The main class of the irc server. * This class contains instances of all the other classes in this software. * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser @@ -302,14 +208,6 @@ class CoreExport InspIRCd /** Actions that must happen outside of the current call stack */ ActionList AtomicActions; - /**** Functors ****/ - - IsNickHandler HandleIsNick; - IsIdentHandler HandleIsIdent; - OnCheckExemptionHandler HandleOnCheckExemption; - IsChannelHandler HandleIsChannel; - GenRandomHandler HandleGenRandom; - /** 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 * Reason for it: * kludge alert! @@ -338,11 +236,11 @@ class CoreExport InspIRCd /** Mode handler, handles mode setting and removal */ - ModeParser* Modes; + ModeParser Modes; /** Command parser, handles client to server commands */ - CommandParser* Parser; + CommandParser Parser; /** Thread engine, Handles threading where required */ @@ -354,17 +252,17 @@ class CoreExport InspIRCd /** LogManager handles logging. */ - LogManager *Logs; + LogManager Logs; /** ModuleManager contains everything related to loading/unloading * modules. */ - ModuleManager* Modules; + ModuleManager Modules; /** BanCacheManager is used to speed up checking of restrictions on connection * to the IRCd. */ - BanCacheManager *BanCache; + BanCacheManager BanCache; /** Stats class, holds miscellaneous stats counters */ @@ -377,7 +275,7 @@ class CoreExport InspIRCd /** Snomask manager - handles routing of snomask messages * to opers. */ - SnomaskManager* SNO; + SnomaskManager SNO; /** Timer manager class, triggers Timer timer events */ @@ -389,7 +287,7 @@ class CoreExport InspIRCd /** User manager. Various methods and data associated with users. */ - UserManager *Users; + UserManager Users; /** Channel list, a hash_map containing all channels XXX move to channel manager class */ @@ -407,9 +305,9 @@ class CoreExport InspIRCd */ ProtocolInterface* PI; - /** Holds extensible for user operquit + /** Default implementation of the ProtocolInterface, does nothing */ - StringExtItem OperQuit; + ProtocolInterface DefaultProtocolInterface; /** Manages the generation and transmission of ISUPPORT. */ ISupportManager ISupport; @@ -430,29 +328,34 @@ class CoreExport InspIRCd * @param printable if false, the string will use characters 0-255; otherwise, * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters) */ - std::string GenRandomStr(int length, bool printable = true); + std::string GenRandomStr(unsigned int length, bool printable = true); /** Generate a random integer. * This is generally more secure than rand() */ unsigned long GenRandomInt(unsigned long max); /** Fill a buffer with random bits */ - caller2 GenRandom; + TR1NS::function GenRandom; + + /** Fills the output buffer with the specified number of random characters. + * This is the default function for InspIRCd::GenRandom. + * @param output The output buffer to store random characters in. + * @param max The maximum number of random characters to put in the buffer. + */ + static void DefaultGenRandom(char* output, size_t max); + + /** Bind to a specific port from a config tag. + * @param Tag the tag that contains bind information. + * @param sa The endpoint to listen on. + * @params old_ports Previously listening ports that may be on the same endpoint. + */ + bool BindPort(ConfigTag* tag, const irc::sockets::sockaddrs& sa, std::vector& old_ports); /** Bind all ports specified in the configuration file. * @return The number of ports bound without error */ int BindPorts(FailedPortList &failed_ports); - /** Binds a socket on an already open file descriptor - * @param sockfd A valid file descriptor of an open socket - * @param port The port number to bind to - * @param addr The address to bind to (IP only) - * @param dolisten Should this port be listened on? - * @return True if the port was bound successfully - */ - bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true); - /** Find a user in the nick hash. * If the user cant be found in the nick hash check the uuid hash * @param nick The nickname to find @@ -475,11 +378,21 @@ class CoreExport InspIRCd */ chan_hash& GetChans() { return chanlist; } - /** Return true if a channel name is valid - * @param chname A channel name to verify - * @return True if the name is valid + /** Determines whether an channel name is valid. */ + TR1NS::function IsChannel; + + /** Determines whether a channel name is valid according to the RFC 1459 rules. + * This is the default function for InspIRCd::IsChannel. + * @param channel The channel name to validate. + * @return True if the channel name is valid according to RFC 1459 rules; otherwise, false. + */ + static bool DefaultIsChannel(const std::string& channel); + + /** Determines whether a hostname is valid according to RFC 5891 rules. + * @param host The hostname to validate. + * @return True if the hostname is valid; otherwise, false. */ - caller1 IsChannel; + static bool IsHost(const std::string& host); /** Return true if str looks like a server ID * @param sid string to check against @@ -504,35 +417,33 @@ class CoreExport InspIRCd */ void Exit(int status); - /** Causes the server to exit immediately with exit code 0. - * The status code is required for signal handlers, and ignored. - */ - static void QuickExit(int status); - /** Formats the input string with the specified arguments. * @param formatString The string to format * @param ... A variable number of format arguments. * @return The formatted string */ - static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2); - static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0); + static std::string Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2); + static std::string Format(va_list& vaList, const char* formatString) CUSTOM_PRINTF(2, 0); - /** Send an error notice to all local users, opered and unopered - * @param s The error string to send - */ - void SendError(const std::string &s); + /** Determines whether a nickname is valid. */ + TR1NS::function IsNick; - /** Return true if a nickname is valid - * @param n A nickname to verify - * @return True if the nick is valid + /** Determines whether a nickname is valid according to the RFC 1459 rules. + * This is the default function for InspIRCd::IsNick. + * @param nick The nickname to validate. + * @return True if the nickname is valid according to RFC 1459 rules; otherwise, false. */ - caller1 IsNick; + static bool DefaultIsNick(const std::string& nick); - /** Return true if an ident is valid - * @param An ident to verify - * @return True if the ident is valid - */ - caller1 IsIdent; + /** Determines whether an ident is valid. */ + TR1NS::function IsIdent; + + /** Determines whether a ident is valid according to the RFC 1459 rules. + * This is the default function for InspIRCd::IsIdent. + * @param ident The ident to validate. + * @return True if the ident is valid according to RFC 1459 rules; otherwise, false. + */ + static bool DefaultIsIdent(const std::string& ident); /** Match two strings using pattern matching, optionally, with a map * to check case against (may be NULL). If map is null, match will be case insensitive. @@ -566,7 +477,7 @@ class CoreExport InspIRCd */ static bool IsValidMask(const std::string& mask); - /** Strips all color codes from the given string + /** Strips all color and control codes except 001 from the given string * @param sentence The string to strip from */ static void StripColor(std::string &sentence); @@ -606,9 +517,10 @@ class CoreExport InspIRCd /** Attempt to write the process id to a given file * @param filename The PID file to attempt to write to + * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure * @return This function may bail if the file cannot be written */ - void WritePID(const std::string &filename); + void WritePID(const std::string& filename, bool exitonfail = true); /** This constructor initialises all the subsystems and reads the config file. * @param argc The argument count passed to main() @@ -619,30 +531,6 @@ class CoreExport InspIRCd */ InspIRCd(int argc, char** argv); - /** Send a line of WHOIS data to a user. - * @param user user to send the line to - * @param dest user being WHOISed - * @param numeric Numeric to send - * @param text Text of the numeric - */ - void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text); - - /** Send a line of WHOIS data to a user. - * @param user user to send the line to - * @param dest user being WHOISed - * @param numeric Numeric to send - * @param format Format string for the numeric - * @param ... Parameters for the format string - */ - void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6); - - /** Called to check whether a channel restriction mode applies to a user - * @param User that is attempting some action - * @param Channel that the action is being performed on - * @param Action name - */ - caller3 OnCheckExemption; - /** Prepare the ircd for restart or shutdown. * This function unloads all modules which can be unloaded, * closes all open sockets, and closes the logfile. @@ -650,8 +538,22 @@ class CoreExport InspIRCd void Cleanup(); /** Return a time_t as a human-readable string. + * @param format The format to retrieve the date/time in. See `man 3 strftime` + * for more information. If NULL, "%a %b %d %T %Y" is assumed. + * @param curtime The timestamp to convert to a human-readable string. + * @param utc True to convert the time to string as-is, false to convert it to local time first. + * @return A string representing the given date/time. */ - static std::string TimeString(time_t curtime); + static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false); + + /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function + * returns false immediately (leaking information about the length), otherwise it compares each + * character and only returns after all characters have been compared. + * @param one First string + * @param two Second string + * @return True if the strings match, false if they don't + */ + static bool TimingSafeCompare(const std::string& one, const std::string& two); /** Begin execution of the server. * NOTE: this function NEVER returns. Internally, @@ -676,7 +578,7 @@ class CommandModule : public Module { } - Version GetVersion() + Version GetVersion() CXX11_OVERRIDE { return Version(cmd.name, VF_VENDOR|VF_CORE); } @@ -687,3 +589,5 @@ inline void stdalgo::culldeleter::operator()(classbase* item) if (item) ServerInstance->GlobalCulls.AddItem(item); } + +#include "numericbuilder.h"