X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=9c9609530b0cc867e8be250be0750ae61b3b0d8a;hb=b9e323b2c3c7f44422cb762c0412665c4fd52cdc;hp=5461adcca2064e8192f4a2bd278b2aa4e51eaba0;hpb=96a4a1d41e42dba806c2e9954e148ed838262511;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 5461adcca..dab00d31c 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -1,85 +1,69 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * 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 * - * This program is free but copyrighted software; see - * the file COPYING for details. + * 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 + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __INSPIRCD_H__ -#define __INSPIRCD_H__ -#define _FILE_OFFSET_BITS 64 -#ifndef _LARGEFILE_SOURCE -#define _LARGEFILE_SOURCE -#endif +#pragma once -#ifndef WIN32 -#define DllExport -#define CoreExport -#define printf_c printf -#else -#include "inspircd_win32wrapper.h" -/** Windows defines these already */ -#undef DELETE -#undef ERROR -#endif - -#ifdef __GNUC__ -#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST))) -#else -#define CUSTOM_PRINTF(STRING, FIRST) -#endif - -// Required system headers. -#include -#include -#include +#include #include +#include +#include +#include #include -#include +#include -#include -#include -#include -#include +#include +#include #include +#include #include -#include #include +#include +#include +#include -/** A list of failed port bindings, used for informational purposes on startup */ -typedef std::vector > FailedPortList; - -/** A cached text file stored with its contents as lines - */ -typedef std::deque< std::string > file_cache; - -/** A configuration key and value pair - */ -typedef std::pair< std::string, std::string > KeyVal; - -/** A list of related configuration keys and values - */ -typedef std::vector< KeyVal > KeyValList; +#include "intrusive_list.h" +#include "compat.h" +#include "typedefs.h" +#include "stdalgo.h" -/** An entire config file, built up of KeyValLists - */ -typedef std::multimap< std::string, KeyValList > ConfigDataHash; +CoreExport extern InspIRCd* ServerInstance; -#include "inspircd_config.h" +#include "config.h" +#include "dynref.h" +#include "consolecolors.h" +#include "caller.h" +#include "cull_list.h" +#include "extensible.h" +#include "fileutils.h" #include "numerics.h" #include "uid.h" +#include "server.h" #include "users.h" #include "channels.h" #include "timer.h" #include "hashcomp.h" -#include "typedefs.h" #include "logger.h" #include "usermanager.h" #include "socket.h" @@ -88,51 +72,31 @@ typedef std::multimap< std::string, KeyValList > ConfigDataHash; #include "mode.h" #include "socketengine.h" #include "snomasks.h" -#include "cull_list.h" #include "filelogger.h" -#include "caller.h" #include "modules.h" +#include "threadengine.h" #include "configreader.h" #include "inspstring.h" #include "protocol.h" - -#ifndef PATH_MAX -#warning Potentially broken system, PATH_MAX undefined -#define PATH_MAX 4096 -#endif - -/** - * Used to define the maximum number of parameters a command may have. - */ -#define MAXPARAMETERS 127 - -/** Returned by some functions to indicate failure. - */ -#define ERROR -1 - -/** Support for librodent - - * see http://www.chatspike.net/index.php?z=64 - */ -#define ETIREDHAMSTERS EAGAIN +#include "bancache.h" /** Template function to convert any input type to std::string */ template inline std::string ConvNumeric(const T &in) { - if (in == 0) return "0"; - char res[MAXBUF]; - char* out = res; + if (in == 0) + return "0"; T quotient = in; - while (quotient) { - *out = "0123456789"[ std::abs( (long)quotient % 10 ) ]; - ++out; + std::string out; + while (quotient) + { + out += "0123456789"[ std::abs( (long)quotient % 10 ) ]; quotient /= 10; } if (in < 0) - *out++ = '-'; - *out = 0; - std::reverse(res,out); - return res; + out += '-'; + std::reverse(out.begin(), out.end()); + return out; } /** Template function to convert any input type to std::string @@ -167,7 +131,7 @@ inline std::string ConvToStr(const bool in) */ inline std::string ConvToStr(char in) { - return std::string(in,1); + return std::string(1, in); } /** Template function to convert any input type to std::string @@ -186,137 +150,122 @@ template inline long ConvToInt(const T &in) { std::stringstream tmp; if (!(tmp << in)) return 0; - return atoi(tmp.str().c_str()); + return atol(tmp.str().c_str()); } -/** Template function to convert integer to char, storing result in *res and - * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages. - * @param T input value - * @param V result value - * @param R base to convert to - */ -template inline char* itoa(const T &in, V *res, R base) +inline uint64_t ConvToUInt64(const std::string& in) { - if (base < 2 || base > 16) { *res = 0; return res; } - char* out = res; - int quotient = in; - while (quotient) { - *out = "0123456789abcdef"[ std::abs( quotient % base ) ]; - ++out; - quotient /= base; - } - if ( in < 0 && base == 10) *out++ = '-'; - std::reverse( res, out ); - *out = 0; - return res; + uint64_t ret; + std::istringstream tmp(in); + if (!(tmp >> ret)) + return 0; + return ret; } /** This class contains various STATS counters * It is used by the InspIRCd class, which internally * has an instance of it. */ -class serverstats : public classbase +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 */ - double statsSent; + unsigned long Sent; /** Total bytes of data received */ - double statsRecv; + unsigned long Recv; +#ifdef _WIN32 + /** Cpu usage at last sample + */ + FILETIME LastCPU; + /** Time QP sample was read + */ + LARGE_INTEGER LastSampled; + /** QP frequency + */ + LARGE_INTEGER QPFrequency; +#else /** Cpu usage at last sample */ timeval LastCPU; /** Time last sample was read */ - timeval LastSampled; + timespec LastSampled; +#endif /** 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.0), statsRecv(0.0) + : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0), + DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0) { } }; -class InspIRCd; - -DEFINE_HANDLER1(ProcessUserHandler, void, User*); -DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t); -DEFINE_HANDLER1(IsIdentHandler, bool, const char*); -DEFINE_HANDLER1(FindDescriptorHandler, User*, int); -DEFINE_HANDLER1(FloodQuitUserHandler, void, User*); -DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t); -DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&); -DEFINE_HANDLER1(RehashHandler, void, const std::string&); - -/* Forward declaration - required */ -class XLineManager; -class BanCacheManager; - -/** The background thread for config reading, so that reading from executable includes - * does not block. - */ -class CoreExport ConfigReaderThread : public Thread +/** This class manages the generation and transmission of ISUPPORT. */ +class CoreExport ISupportManager { - InspIRCd* ServerInstance; - bool do_bail; - std::string TheUserUID; - public: - ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid) : Thread(), ServerInstance(Instance), do_bail(bail), TheUserUID(useruid) - { - } +private: + /** The generated lines which are sent to clients. */ + std::vector Lines; + +public: + /** (Re)build the ISUPPORT vector. */ + void Build(); - virtual ~ConfigReaderThread() + /** Returns the std::vector of ISUPPORT lines. */ + const std::vector& GetLines() { + return this->Lines; } - void Run(); + /** 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, with the exception of the base class, - * classbase. Amongst other things, it contains a ModeParser, - * a DNS object, a CommandParser object, and a list of active - * Module objects, and facilities for Module objects to - * interact with the core system it implements. + * This class contains instances of all the other classes in this software. + * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser + * object, and a list of active Module objects, and facilities for Module + * objects to interact with the core system it implements. */ -class CoreExport InspIRCd : public classbase +class CoreExport InspIRCd { private: - /** Holds the current UID. Used to generate the next one. - */ - char current_uid[UUID_LENGTH]; - /** Set up the signal handlers */ void SetSignals(); @@ -326,77 +275,37 @@ class CoreExport InspIRCd : public classbase */ bool DaemonSeed(); - /** Iterate the list of BufferedSocket objects, removing ones which have timed out - * @param TIME the current time - */ - void DoSocketTimeouts(time_t TIME); - - /** Increments the current UID by one. - */ - void IncrementUID(int pos); - - /** Perform background user events such as PING checks - */ - void DoBackgroundUserStuff(); - - /** Returns true when all modules have done pre-registration checks on a user - * @param user The user to verify - * @return True if all modules have finished checking this user - */ - bool AllModulesReportReady(User* user); - - /** Logfile pathname specified on the commandline, or empty string - */ - char LogFileName[MAXBUF]; - /** The current time, updated in the mainloop */ - time_t TIME; - - /** The time that was recorded last time around the mainloop - */ - time_t OLDTIME; + struct timespec TIME; /** A 64k buffer used to read socket data into * NOTE: update ValidateNetBufferSize if you change this */ char ReadBuffer[65535]; - /** Used when connecting clients - */ - irc::sockets::insp_sockaddr client, server; - - /** Used when connecting clients + /** Check we aren't running as root, and exit if we are + * with exit code EXIT_STATUS_ROOT. */ - socklen_t length; - -#ifdef WIN32 - IPC* WindowsIPC; -#endif + void CheckRoot(); public: + UIDGenerator UIDGen; + /** Global cull list, will be processed on next iteration */ CullList GlobalCulls; + /** Actions that must happen outside of the current call stack */ + ActionList AtomicActions; /**** Functors ****/ - ProcessUserHandler HandleProcessUser; IsNickHandler HandleIsNick; IsIdentHandler HandleIsIdent; - FindDescriptorHandler HandleFindDescriptor; - FloodQuitUserHandler HandleFloodQuitUser; + OnCheckExemptionHandler HandleOnCheckExemption; IsChannelHandler HandleIsChannel; - IsSIDHandler HandleIsSID; - RehashHandler HandleRehash; - - /** BufferedSocket classes pending deletion after being closed. - * We don't delete these immediately as this may cause a segmentation fault. - */ - std::map SocketCull; - - Mutex* RehashFinishMutex; + 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: @@ -406,31 +315,13 @@ class CoreExport InspIRCd : public classbase * hash and set its descriptor to FD_MAGIC_NUMBER so the data * falls into the abyss :p */ - User* FakeClient; - - /** Returns the next available UID for this server. - */ - std::string GetUID(); - - /** Find a user in the UUID hash - * @param nick The nickname to find - * @return A pointer to the user, or NULL if the user does not exist - */ - User* FindUUID(const std::string &); + FakeUser* FakeClient; /** Find a user in the UUID hash - * @param nick The nickname to find + * @param uid The UUID to find * @return A pointer to the user, or NULL if the user does not exist */ - User* FindUUID(const char *); - - /** Build the ISUPPORT string by triggering all modules On005Numeric events - */ - void BuildISupport(); - - /** List of server names we've seen. - */ - servernamelist servernames; + User* FindUUID(const std::string &uid); /** Time this ircd was booted */ @@ -438,7 +329,9 @@ class CoreExport InspIRCd : public classbase /** Config file pathname specified on the commandline or via ./configure */ - char ConfigFileName[MAXBUF]; + std::string ConfigFileName; + + ExtensionManager Extensions; /** Mode handler, handles mode setting and removal */ @@ -446,19 +339,11 @@ class CoreExport InspIRCd : public classbase /** 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; - - /** Mutex engine, handles mutexes for threading where required - */ - MutexFactory* Mutexes; + ThreadEngine Threads; /** The thread/class used to read config files in REHASH and on startup */ @@ -476,11 +361,11 @@ class CoreExport InspIRCd : public classbase /** 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 */ @@ -491,13 +376,9 @@ class CoreExport InspIRCd : public classbase */ SnomaskManager* SNO; - /** DNS class, provides resolver facilities to the core and modules - */ - DNS* Res; - /** Timer manager class, triggers Timer timer events */ - TimerManager* Timers; + TimerManager Timers; /** X-Line manager. Handles G/K/Q/E line setting, removal and matching */ @@ -509,72 +390,70 @@ class CoreExport InspIRCd : public classbase /** 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 + */ + std::vector ports; /** Set to the current signal recieved */ - int s_signal; + static sig_atomic_t s_signal; /** Protocol interface, overridden by server protocol modules */ ProtocolInterface* PI; + /** Default implementation of the ProtocolInterface, does nothing + */ + ProtocolInterface DefaultProtocolInterface; + + /** Holds extensible for user operquit + */ + StringExtItem OperQuit; + + /** Manages the generation and transmission of ISUPPORT. */ + ISupportManager ISupport; + /** Get the current time * Because this only calls time() once every time around the mainloop, * it is much faster than calling time() directly. * @return The current time as an epoch value (time_t) */ - time_t Time(); + inline time_t Time() { return TIME.tv_sec; } + /** The fractional time at the start of this mainloop iteration (nanoseconds) */ + inline long Time_ns() { return TIME.tv_nsec; } + /** Update the current time. Don't call this unless you have reason to do so. */ + void UpdateTime(); - /** Process a user whos socket has been flagged as active - * @param cu The user to process - * @return There is no actual return value, however upon exit, the user 'cu' may have been - * marked for deletion in the global CullList. + /** Generate a random string with the given length + * @param length The length in bytes + * @param printable if false, the string will use characters 0-255; otherwise, + * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters) */ - caller1 ProcessUser; + std::string GenRandomStr(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; /** Bind all ports specified in the configuration file. - * @param bail True if the function should bail back to the shell on failure - * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound - * @return The number of ports actually bound without error + * @return The number of ports bound without error */ - int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports); + 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); - /** Adds a server name to the list of servers we've seen - * @param The servername to add - */ - void AddServerName(const std::string &servername); - - /** Finds a cached char* pointer of a server name, - * This is used to optimize User by storing only the pointer to the name - * @param The servername to find - * @return A pointer to this name, gauranteed to never become invalid - */ - const char* FindServerNamePtr(const std::string &servername); - - /** Returns true if we've seen the given server name before - * @param The servername to find - * @return True if we've seen this server name before - */ - bool FindServerName(const std::string &servername); - - /** 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 - */ - std::string GetServerDescription(const char* servername); - /** 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 @@ -582,17 +461,6 @@ class CoreExport InspIRCd : public classbase */ User* FindNick(const std::string &nick); - /** 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 - * @return A pointer to the user, or NULL if the user does not exist - */ - User* FindNick(const char* nick); - - /** Find a user in the nick hash ONLY - */ - User* FindNickOnly(const char* nick); - /** Find a user in the nick hash ONLY */ User* FindNickOnly(const std::string &nick); @@ -603,43 +471,21 @@ class CoreExport InspIRCd : public classbase */ Channel* FindChan(const std::string &chan); - /** Find a channel in the channels hash - * @param chan The channel to find - * @return A pointer to the channel, or NULL if the channel does not exist - */ - Channel* FindChan(const char* chan); - - /** Check for a 'die' tag in the config file, and abort if found - * @return Depending on the configuration, this function may never return - */ - void CheckDie(); - - /** Check we aren't running as root, and exit if we are - * @return Depending on the configuration, this function may never return - */ - void CheckRoot(); - - /** Determine the right path for, and open, the logfile - * @param argv The argv passed to main() initially, used to calculate program path - * @param argc The argc passed to main() initially, used to calculate program path - * @return True if the log could be opened, false if otherwise + /** Get a hash map containing all channels, keyed by their name + * @return A hash map mapping channel names to Channel pointers */ - bool OpenLog(char** argv, int argc); + 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 */ - caller2 IsChannel; + caller1 IsChannel; /** Return true if str looks like a server ID - * @param string to check against - */ - caller1 IsSID; - - /** Rehash the local server + * @param sid string to check against */ - caller1 Rehash; + static bool IsSID(const std::string& sid); /** Handles incoming signals after being set * @param signal the signal recieved @@ -654,7 +500,7 @@ class CoreExport InspIRCd : public classbase /** Causes the server to exit after unloading modules and * closing all open file descriptors. * - * @param The exit code to give to the operating system + * @param status The exit code to give to the operating system * (See the ExitStatus enum for valid values) */ void Exit(int status); @@ -664,10 +510,13 @@ class CoreExport InspIRCd : public classbase */ static void QuickExit(int status); - /** Return a count of channels on the network - * @return The number of channels - */ - long ChannelCount(); + /** 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); /** Send an error notice to all local users, opered and unopered * @param s The error string to send @@ -678,137 +527,67 @@ class CoreExport InspIRCd : public classbase * @param n A nickname to verify * @return True if the nick is valid */ - caller2 IsNick; + caller1 IsNick; /** Return true if an ident is valid * @param An ident to verify * @return True if the ident is valid */ - caller1 IsIdent; - - /** Find a username by their file descriptor. - * It is preferred to use this over directly accessing the fd_ref_table array. - * @param socket The file descriptor of a user - * @return A pointer to the user if the user exists locally on this descriptor - */ - caller1 FindDescriptor; - - /** Add a dns Resolver class to this server's active set - * @param r The resolver to add - * @param cached If this value is true, then the cache will - * be searched for the DNS result, immediately. If the value is - * false, then a request will be sent to the nameserver, and the - * result will not be immediately available. You should usually - * use the boolean value which you passed to the Resolver - * constructor, which Resolver will set appropriately depending - * on if cached results are available and haven't expired. It is - * however safe to force this value to false, forcing a remote DNS - * lookup, but not an update of the cache. - * @return True if the operation completed successfully. Note that - * if this method returns true, you should not attempt to access - * the resolver class you pass it after this call, as depending upon - * the request given, the object may be deleted! - */ - bool AddResolver(Resolver* r, bool cached); - - /** Add a command to this server's command parser - * @param f A Command command handler object to add - * @throw ModuleException Will throw ModuleExcption if the command already exists - */ - void AddCommand(Command *f); - - /** Send a modechange. - * The parameters provided are identical to that sent to the - * handler for class cmd_mode. - * @param parameters The mode parameters - * @param user The user to send error messages to - */ - void SendMode(const std::vector& parameters, User *user); + caller1 IsIdent; /** 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. * @param str The literal string to match against * @param mask The glob pattern to match against. + * @param map The character map to use when matching. */ - static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL); - static bool Match(const char *str, const char *mask, unsigned const char *map = NULL); + static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL); + static bool Match(const char* str, const char* mask, unsigned const char* map = NULL); /** 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. * Supports CIDR patterns as well as globs. * @param str The literal string to match against * @param mask The glob or CIDR pattern to match against. + * @param map The character map to use when matching. */ - static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL); - static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL); + static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL); + static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL); - /** Call the handler for a given command. - * @param commandname The command whos handler you wish to call - * @param parameters The mode parameters - * @param pcnt The number of items you have given in the first parameter - * @param user The user to execute the command as - * @return True if the command handler was called successfully + /** Matches a hostname and IP against a space delimited list of hostmasks. + * @param masks The space delimited masks to match against. + * @param hostname The hostname to try and match. + * @param ipaddr The IP address to try and match. */ - CmdResult CallCommandHandler(const std::string &commandname, const std::vector& parameters, User* user); - - /** Return true if the command is a module-implemented command and the given parameters are valid for it - * @param parameters The mode parameters - * @param pcnt The number of items you have given in the first parameter - * @param user The user to test-execute the command as - * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command - */ - bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user); + static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr); /** Return true if the given parameter is a valid nick!user\@host mask * @param mask A nick!user\@host masak to match against * @return True i the mask is valid */ - bool IsValidMask(const std::string &mask); - - /** Rehash the local server - */ - void RehashServer(); - - /** Return the channel whos index number matches that provided - * @param The index number of the channel to fetch - * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount() - */ - Channel* GetChannelIndex(long index); - - /** Dump text to a user target, splitting it appropriately to fit - * @param User the user to dump the text to - * @param LinePrefix text to prefix each complete line with - * @param TextStream the text to send to the user - */ - void DumpText(User* User, const std::string &LinePrefix, std::stringstream &TextStream); + static bool IsValidMask(const std::string& mask); - /** 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 + /** Strips all color codes from the given string + * @param sentence The string to strip from */ - bool NickMatchesEveryone(const std::string &nick, User* user); + static void StripColor(std::string &sentence); - /** 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 + /** Parses color codes from string values to actual color codes + * @param input The data to process */ - bool IPMatchesEveryone(const std::string &ip, User* user); + static void ProcessColors(file_cache& input); - /** 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 + /** Rehash the local server + * @param uuid The uuid of the user who started the rehash, can be empty */ - bool HostMatchesEveryone(const std::string &mask, User* user); + void Rehash(const std::string& uuid = ""); /** 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) * @return The total number of seconds */ - long Duration(const std::string &str); + static unsigned long Duration(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 @@ -817,31 +596,14 @@ class CoreExport InspIRCd : public classbase * @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 - */ - int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype); - - /** Check if a given server is a uline. - * An empty string returns true, this is by design. - * @param server The server to check for uline status - * @return True if the server is a uline OR the string is empty - */ - bool ULine(const char* server); - - /** Returns true if the uline is 'silent' (doesnt generate - * remote connect notices etc). - */ - bool SilentULine(const char* server); - - /** Returns the subversion revision ID of this ircd - * @return The revision ID or an empty string + * @return True if the strings match, false if they do not */ - std::string GetRevision(); + 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 */ - std::string GetVersionString(); + std::string GetVersionString(bool getFullVersion = false); /** Attempt to write the process id to a given file * @param filename The PID file to attempt to write to @@ -875,19 +637,12 @@ class CoreExport InspIRCd : public classbase */ void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6); - /** Quit a user for excess flood, and if they are not - * fully registered yet, temporarily zline their IP. - * @param current user to quit - */ - caller1 FloodQuitUser; - - /** Restart the server. - * This function will not return. If an error occurs, - * it will throw an instance of CoreException. - * @param reason The restart reason to show to all clients - * @throw CoreException An instance of CoreException indicating the error from execv(). + /** 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 */ - void Restart(const std::string &reason); + caller3 OnCheckExemption; /** Prepare the ircd for restart or shutdown. * This function unloads all modules which can be unloaded, @@ -895,36 +650,15 @@ class CoreExport InspIRCd : public classbase */ void Cleanup(); - /** This copies the user and channel hash_maps into new hash maps. - * This frees memory used by the hash_map allocator (which it neglects - * to free, most of the time, using tons of ram) - */ - void RehashUsersAndChans(); - - /** Resets the cached max bans value on all channels. - * Called by rehash. - */ - void ResetMaxBans(); - /** Return a time_t as a human-readable string. */ - std::string TimeString(time_t curtime); + static std::string TimeString(time_t curtime); /** Begin execution of the server. * NOTE: this function NEVER returns. Internally, * it will repeatedly loop. - * @return The return value for this function is undefined. - */ - int Run(); - - /** Force all BufferedSockets to be removed which are due to - * be culled. */ - void BufferedSocketCull(); - - /** Adds an extban char to the 005 token. - */ - void AddExtBanChar(char c); + void Run(); char* GetReadBuffer() { @@ -934,4 +668,23 @@ class CoreExport InspIRCd : public classbase ENTRYPOINT; -#endif +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); +}