]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Fix various documentation comments.
[user/henk/code/inspircd.git] / include / inspircd.h
index 633a0d58d3c8e28c50737527637f6d0e277f5ee6..b0e9903f24752ef533b13e6a24fbb9431eb55419 100644 (file)
@@ -1,13 +1,19 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
+ *   Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2014, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007-2009 Dennis Friis <peavey@inspircd.org>
  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
- *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
- *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2003 randomdan <???@???>
+ *   Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
+ *   Copyright (C) 2005-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
 
 #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 <cfloat>
 #include <climits>
 #include <cmath>
 #include <csignal>
@@ -32,6 +43,7 @@
 #include <cstdio>
 #include <cstring>
 #include <ctime>
+#include <stdint.h>
 
 #include <algorithm>
 #include <bitset>
 #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 "serialize.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 +95,20 @@ 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 "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(1, in);
-}
-
-/** 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());
-}
-
-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
@@ -174,38 +119,38 @@ class serverstats
   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
        */
@@ -227,39 +172,12 @@ class serverstats
        /** 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)
-       {
-       }
-};
-
-/** 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()
+               : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
+               DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
        {
-               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
@@ -269,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;
@@ -287,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:
 
@@ -302,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
         */
@@ -338,15 +236,15 @@ 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
         */
-       ThreadEngine* Threads;
+       ThreadEngine Threads;
 
        /** The thread/class used to read config files in REHASH and on startup
         */
@@ -354,21 +252,21 @@ 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
         */
-       serverstats* stats;
+       serverstats stats;
 
        /**  Server Config class, holds configuration file data
         */
@@ -377,19 +275,19 @@ class CoreExport InspIRCd
        /** Snomask manager - handles routing of snomask messages
         * to opers.
         */
-       SnomaskManager* SNO;
+       SnomaskManager SNO;
 
        /** Timer manager class, triggers Timer timer events
         */
        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
         */
@@ -399,7 +297,7 @@ class CoreExport InspIRCd
         */
        std::vector<ListenSocket*> ports;
 
-       /** Set to the current signal recieved
+       /** Set to the current signal received
         */
        static sig_atomic_t s_signal;
 
@@ -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,28 +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<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);
+
+       /** Bind all ports specified in the configuration file.
+        * @return The number of ports bound without error
+        */
+       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
@@ -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<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.
         */
-       caller1<bool, const std::string&> IsChannel;
+       static bool IsHost(const std::string& host);
 
        /** Return true if str looks like a server ID
         * @param sid string to check against
@@ -487,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);
 
@@ -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<bool(const std::string&)> 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<bool, const std::string&> 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<bool, const std::string&> IsIdent;
+       /** Determines whether an ident is valid. */
+       TR1NS::function<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.
@@ -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);
@@ -588,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.
@@ -606,9 +537,9 @@ class CoreExport InspIRCd
 
        /** Attempt to write the process id to a given file
         * @param filename The PID file to attempt to write to
-        * @return This function may bail if the file cannot be written
+        * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure
         */
-       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 +550,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<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.
@@ -650,8 +557,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, 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 std::string TimeString(time_t curtime);
+       static bool TimingSafeCompare(const std::string& one, const std::string& two);
 
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
@@ -663,27 +584,30 @@ class CoreExport InspIRCd
        {
                return this->ReadBuffer;
        }
+
+       ClientProtocol::RFCEvents& GetRFCEvents() { return rfcevents; }
 };
 
 ENTRYPOINT;
 
-template<class Cmd>
-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 "clientprotocolmsg.h"
+#include "clientprotocolevent.h"