#pragma once
+#include <cfloat>
#include <climits>
#include <cmath>
#include <csignal>
#include <cstdio>
#include <cstring>
#include <ctime>
+#include <stdint.h>
#include <algorithm>
#include <bitset>
#include <string>
#include <vector>
+#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 <typename T>
+struct fakederef
+{
+ T* operator->()
+ {
+ return static_cast<T*>(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"
#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 "clientprotocol.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<typename T> 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(in,1);
-}
-
-/** Template function to convert any input type to std::string
- */
-template <class T> 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<typename T> inline long ConvToInt(const T &in)
-{
- std::stringstream tmp;
- if (!(tmp << in)) return 0;
- return atol(tmp.str().c_str());
-}
+#include "bancache.h"
+#include "isupportmanager.h"
/** This class contains various STATS counters
* It is used by the InspIRCd class, which internally
public:
/** Number of accepted connections
*/
- unsigned long statsAccept;
+ unsigned long Accept;
/** Number of failed accepts
*/
- unsigned long statsRefused;
+ unsigned long Refused;
/** Number of unknown commands seen
*/
- unsigned long statsUnknown;
+ unsigned long Unknown;
/** Number of nickname collisions handled
*/
- unsigned long statsCollisions;
+ unsigned long Collisions;
/** Number of DNS queries sent out
*/
- unsigned long statsDns;
+ unsigned long Dns;
/** Number of good DNS replies received
* NOTE: This may not tally to the number sent out,
* due to timeouts and other latency issues.
*/
- unsigned long statsDnsGood;
+ unsigned long DnsGood;
/** Number of bad (negative) DNS replies received
* NOTE: This may not tally to the number sent out,
* due to timeouts and other latency issues.
*/
- unsigned long statsDnsBad;
+ unsigned long DnsBad;
/** Number of inbound connections seen
*/
- unsigned long statsConnects;
+ unsigned long Connects;
/** Total bytes of data transmitted
*/
- unsigned long statsSent;
+ unsigned long Sent;
/** Total bytes of data received
*/
- unsigned long statsRecv;
+ unsigned long Recv;
#ifdef _WIN32
/** Cpu usage at last sample
*/
/** The constructor initializes all the counts to zero
*/
serverstats()
- : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
- statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
+ : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
+ DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
{
}
};
-/** This class manages the generation and transmission of ISUPPORT. */
-class CoreExport ISupportManager
-{
-private:
- /** The generated lines which are sent to clients. */
- std::vector<std::string> Lines;
-
-public:
- /** (Re)build the ISUPPORT vector. */
- void Build();
-
- /** Returns the std::vector of ISUPPORT lines. */
- const std::vector<std::string>& 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
*/
char ReadBuffer[65535];
+ ClientProtocol::RFCEvents rfcevents;
+
/** Check we aren't running as root, and exit if we are
* with exit code EXIT_STATUS_ROOT.
*/
/** 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!
/** Mode handler, handles mode setting and removal
*/
- ModeParser* Modes;
+ ModeParser Modes;
/** Command parser, handles client to server commands
*/
- CommandParser* Parser;
-
- /** Socket engine, handles socket activity events
- */
- SocketEngine* SE;
+ CommandParser Parser;
/** Thread engine, Handles threading where required
*/
- ThreadEngine* Threads;
+ ThreadEngine Threads;
/** The thread/class used to read config files in REHASH and on startup
*/
/** 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
*/
- serverstats* stats;
+ serverstats stats;
/** Server Config class, holds configuration file data
*/
/** Snomask manager - handles routing of snomask messages
* to opers.
*/
- SnomaskManager* SNO;
+ SnomaskManager SNO;
/** Timer manager class, triggers Timer timer events
*/
- TimerManager* Timers;
+ TimerManager Timers;
- /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
+ /** X-line manager. Handles G/K/Q/E-line setting, removal and matching
*/
XLineManager* XLines;
/** 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
*/
- chan_hash* chanlist;
+ chan_hash chanlist;
/** List of the open ports
*/
*/
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;
* @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<void, char*, size_t> GenRandom;
+ TR1NS::function<void(char*, size_t)> GenRandom;
- /** Bind all ports specified in the configuration file.
- * @return The number of ports bound without error
+ /** 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.
*/
- int BindPorts(FailedPortList &failed_ports);
+ static void DefaultGenRandom(char* output, size_t max);
- /** 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
+ /** Bind to a specific port from a config tag.
+ * @param tag the tag that contains bind information.
+ * @param sa The endpoint to listen on.
+ * @param old_ports Previously listening ports that may be on the same endpoint.
*/
- bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
+ bool BindPort(ConfigTag* tag, const irc::sockets::sockaddrs& sa, std::vector<ListenSocket*>& old_ports);
- /** Gets the GECOS (description) field of the given server.
- * If the servername is not that of the local server, the name
- * is passed to handling modules which will attempt to determine
- * the GECOS that bleongs to the given servername.
- * @param servername The servername to find the description of
- * @return The description of this server, or of the local server
+ /** Bind all ports specified in the configuration file.
+ * @return The number of ports bound without error
*/
- std::string GetServerDescription(const std::string& servername);
+ int BindPorts(FailedPortList &failed_ports);
/** Find a user in the nick hash.
* If the user cant be found in the nick hash check the uuid hash
*/
Channel* FindChan(const std::string &chan);
- /** Return true if a channel name is valid
- * @param chname A channel name to verify
- * @return True if the name is valid
+ /** Get a hash map containing all channels, keyed by their name
+ * @return A hash map mapping channel names to Channel pointers
*/
- caller1<bool, const std::string&> IsChannel;
+ chan_hash& GetChans() { return chanlist; }
+
+ /** Determines whether an channel name is valid. */
+ TR1NS::function<bool(const std::string&)> 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.
+ */
+ static bool IsHost(const std::string& host);
/** Return true if str looks like a server ID
* @param sid string to check against
*/
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);
- /** Return a count of channels on the network
- * @return The number of channels
- */
- long ChannelCount() const { return chanlist->size(); }
+ /** Determines whether a nickname is valid. */
+ TR1NS::function<bool(const std::string&)> IsNick;
- /** Send an error notice to all local users, opered and unopered
- * @param s The error string to send
+ /** 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.
*/
- void SendError(const std::string &s);
+ static bool DefaultIsNick(const std::string& nick);
- /** Return true if a nickname is valid
- * @param n A nickname to verify
- * @return True if the nick is valid
- */
- caller1<bool, const std::string&> IsNick;
+ /** Determines whether an ident is valid. */
+ TR1NS::function<bool(const std::string&)> IsIdent;
- /** Return true if an ident is valid
- * @param An ident to verify
- * @return True if the ident is valid
- */
- caller1<bool, const std::string&> 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.
*/
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);
*/
void Rehash(const std::string& uuid = "");
- /** Check if the given nickmask matches too many users, send errors to the given user
- * @param nick A nickmask to match against
- * @param user A user to send error text to
- * @return True if the nick matches too many users
- */
- bool NickMatchesEveryone(const std::string &nick, User* user);
-
- /** Check if the given IP mask matches too many users, send errors to the given user
- * @param ip An ipmask to match against
- * @param user A user to send error text to
- * @return True if the ip matches too many users
- */
- bool IPMatchesEveryone(const std::string &ip, User* user);
-
- /** Check if the given hostmask matches too many users, send errors to the given user
- * @param mask A hostmask to match against
- * @param user A user to send error text to
- * @return True if the host matches too many users
- */
- bool HostMatchesEveryone(const std::string &mask, User* user);
-
/** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
* @param str A string containing a time in the form 1y2w3d4h6m5s
* (one year, two weeks, three days, four hours, six minutes and five seconds)
*/
static unsigned long Duration(const std::string& str);
+ /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
+ * @param str A string containing a time in the form 1y2w3d4h6m5s
+ * (one year, two weeks, three days, four hours, six minutes and five seconds)
+ * @param duration The location to place the parsed duration valur
+ * @return Whether the duration was a valid format or not
+ */
+ static bool Duration(const std::string& str, unsigned long& duration);
+
+ /** Determines whether a string contains a valid duration.
+ * @param str A string containing a time in the form 1y2w3d4h6m5s
+ * @return True if the string is a valid duration; otherwise, false.
+ */
+ static bool IsValidDuration(const std::string& str);
+
/** Attempt to compare a password to a string from the config file.
* This will be passed to handling modules which will compare the data
* against possible hashed equivalents in the input string.
* @param data The data from the config file
* @param input The data input by the oper
* @param hashtype The hash from the config file
- * @return 0 if the strings match, 1 or -1 if they do not
+ * @return True if the strings match, false if they do not
*/
- int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
+ bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
/** Returns the full version string of this ircd
* @return The version string
/** 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()
*/
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<ModResult, User*, Channel*, const std::string&> 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.
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,
{
return this->ReadBuffer;
}
+
+ ClientProtocol::RFCEvents& GetRFCEvents() { return rfcevents; }
};
ENTRYPOINT;
-template<class Cmd>
-class CommandModule : public Module
+inline void stdalgo::culldeleter::operator()(classbase* item)
{
- Cmd cmd;
- public:
- CommandModule() : cmd(this)
- {
- }
+ if (item)
+ ServerInstance->GlobalCulls.AddItem(item);
+}
- Version GetVersion()
- {
- return Version(cmd.name, VF_VENDOR|VF_CORE);
- }
-};
+inline void Channel::Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status, const CUList& except_list)
+{
+ ClientProtocol::Event event(protoevprov, msg);
+ Write(event, status, except_list);
+}
+
+inline void LocalUser::Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg)
+{
+ ClientProtocol::Event event(protoevprov, msg);
+ Send(event);
+}
+
+#include "numericbuilder.h"
+#include "clientprotocolmsg.h"
+#include "clientprotocolevent.h"