X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=a55d52c0b0e5dff8a0b2e250e0e9b4ef72d3a13c;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=ee09070f858799d5ffca7c534769c9a96dadc3ca;hpb=304b6dbbf56710b1310fce8c5cf71b73334c060a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index ee09070f8..a55d52c0b 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -1,13 +1,19 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2019 Matt Schatz + * Copyright (C) 2018 linuxdaemon + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012-2016, 2018 Attila Molnar + * Copyright (C) 2012-2014, 2017-2019 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2012 ChrisTX + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2009 Dennis Friis * Copyright (C) 2007-2008 Robin Burchell - * Copyright (C) 2008 Pippijn van Steenhoven - * Copyright (C) 2003-2008 Craig Edwards - * Copyright (C) 2006-2007 Oliver Lupton - * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2003 randomdan + * Copyright (C) 2007 Oliver Lupton + * Copyright (C) 2005-2008, 2010 Craig Edwards * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public @@ -25,6 +31,11 @@ #pragma once +// If the system has a pre-C11 stdint header this must be defined in +// order to use the numeric limit macros. +#define __STDC_LIMIT_MACROS + +#include #include #include #include @@ -49,6 +60,7 @@ #include "compat.h" #include "aligned_storage.h" #include "typedefs.h" +#include "convto.h" #include "stdalgo.h" CoreExport extern InspIRCd* ServerInstance; @@ -65,13 +77,13 @@ struct fakederef }; #include "config.h" -#include "convto.h" #include "dynref.h" #include "consolecolors.h" -#include "caller.h" #include "cull_list.h" +#include "serialize.h" #include "extensible.h" #include "fileutils.h" +#include "ctables.h" #include "numerics.h" #include "numeric.h" #include "uid.h" @@ -83,13 +95,14 @@ struct fakederef #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" @@ -165,12 +178,6 @@ class serverstats } }; -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 @@ -180,15 +187,6 @@ DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std:: class CoreExport InspIRCd { private: - /** Set up the signal handlers - */ - void SetSignals(); - - /** Daemonize the ircd and close standard input/output streams - * @return True if the program daemonized succesfully - */ - bool DaemonSeed(); - /** The current time, updated in the mainloop */ struct timespec TIME; @@ -198,10 +196,7 @@ class CoreExport InspIRCd */ char ReadBuffer[65535]; - /** Check we aren't running as root, and exit if we are - * with exit code EXIT_STATUS_ROOT. - */ - void CheckRoot(); + ClientProtocol::RFCEvents rfcevents; public: @@ -213,19 +208,11 @@ 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! * SendMode expects a User* to send the numeric replies - * back to, so we create it a fake user that isnt in the user + * back to, so we create it a fake user that isn't in the user * hash and set its descriptor to FD_MAGIC_NUMBER so the data * falls into the abyss :p */ @@ -294,7 +281,7 @@ class CoreExport InspIRCd */ 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; @@ -310,7 +297,7 @@ class CoreExport InspIRCd */ std::vector ports; - /** Set to the current signal recieved + /** Set to the current signal received */ static sig_atomic_t s_signal; @@ -322,10 +309,6 @@ class CoreExport InspIRCd */ ProtocolInterface DefaultProtocolInterface; - /** Holds extensible for user operquit - */ - StringExtItem OperQuit; - /** Manages the generation and transmission of ISUPPORT. */ ISupportManager ISupport; @@ -345,19 +328,33 @@ 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. + * @param 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); + size_t 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 @@ -381,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 @@ -393,12 +400,12 @@ class CoreExport InspIRCd static bool IsSID(const std::string& sid); /** Handles incoming signals after being set - * @param signal the signal recieved + * @param signal the signal received */ void SignalHandler(int signal); - /** Sets the signal recieved - * @param signal the signal recieved + /** Sets the signal received + * @param signal the signal received */ static void SetSignal(int signal); @@ -410,30 +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); - /** Return true if a nickname is valid - * @param n A nickname to verify - * @return True if the nick is valid - */ - caller1 IsNick; + /** Determines whether a nickname is valid. */ + TR1NS::function IsNick; - /** Return true if an ident is valid - * @param An ident to verify - * @return True if the ident 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 IsIdent; + static bool DefaultIsNick(const std::string& nick); + + /** 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. @@ -489,6 +499,26 @@ class CoreExport InspIRCd */ 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); + + /** Return a duration in seconds as a human-readable string. + * @param duration The duration in seconds to convert to a human-readable string. + * @return A string representing the given duration. + */ + static std::string DurationString(time_t duration); + /** 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. @@ -507,9 +537,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() @@ -520,13 +551,6 @@ class CoreExport InspIRCd */ InspIRCd(int argc, char** argv); - /** 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. @@ -536,6 +560,7 @@ class CoreExport InspIRCd /** 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. */ @@ -560,31 +585,30 @@ class CoreExport InspIRCd { return this->ReadBuffer; } + + ClientProtocol::RFCEvents& GetRFCEvents() { return rfcevents; } }; ENTRYPOINT; -template -class CommandModule : public Module -{ - Cmd cmd; - public: - CommandModule() : cmd(this) - { - } - - Version GetVersion() - { - return Version(cmd.name, VF_VENDOR|VF_CORE); - } -}; - inline void stdalgo::culldeleter::operator()(classbase* item) { if (item) ServerInstance->GlobalCulls.AddItem(item); } +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 "modules/whois.h" -#include "modules/stats.h" +#include "clientprotocolmsg.h" +#include "clientprotocolevent.h"