X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=3a80d2c82fe734c03c7e101ae9a383d90014d722;hb=6e85701ecb09604f2c87010683638ec0446cc515;hp=5f57619d55df82202daa8d3112188b7c8baf9bc8;hpb=af7e1a1ca8b36064593becf62b1a91468ad32237;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 5f57619d5..3a80d2c82 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -14,9 +14,14 @@ #ifndef __INSPIRCD_H__ #define __INSPIRCD_H__ +#define _FILE_OFFSET_BITS 64 +#ifndef _LARGEFILE_SOURCE +#define _LARGEFILE_SOURCE +#endif + #ifndef WIN32 -#define DllExport -#define CoreExport +#define DllExport +#define CoreExport #define printf_c printf #else #include "inspircd_win32wrapper.h" @@ -25,11 +30,51 @@ #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 + +/** 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; + +/** An entire config file, built up of KeyValLists + */ +typedef std::multimap< std::string, KeyValList > ConfigDataHash; #include "inspircd_config.h" +#include "numerics.h" #include "uid.h" #include "users.h" #include "channels.h" @@ -50,6 +95,14 @@ #include "modules.h" #include "configreader.h" #include "inspstring.h" +#include "protocol.h" +#include "threadengine.h" +#include "fakeuser.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. @@ -217,33 +270,52 @@ class serverstats : public classbase } }; -/** A list of failed port bindings, used for informational purposes on startup */ -typedef std::vector > FailedPortList; - class InspIRCd; DEFINE_HANDLER1(ProcessUserHandler, void, User*); -DEFINE_HANDLER1(IsNickHandler, bool, const char*); +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 +{ + InspIRCd* ServerInstance; + ServerConfig* Config; + bool done; + public: + std::string TheUserUID; + ConfigReaderThread(InspIRCd* Instance, const std::string &useruid) + : Thread(), ServerInstance(Instance), done(false), TheUserUID(useruid) + { + } + + virtual ~ConfigReaderThread() + { + } + + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } +}; + /** 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. You should - * NEVER attempt to instantiate a class of type InspIRCd - * yourself. If you do, this is equivalent to spawning a second - * IRC server, and could have catastrophic consequences for the - * program in terms of ram usage (basically, you could create - * an obese forkbomb built from recursively spawning irc servers!) + * interact with the core system it implements. */ class CoreExport InspIRCd : public classbase { @@ -266,9 +338,9 @@ class CoreExport InspIRCd : public classbase */ void DoSocketTimeouts(time_t TIME); - /** Sets up UID subsystem + /** Increments the current UID by one. */ - void InitialiseUID(); + void IncrementUID(int pos); /** Perform background user events such as PING checks */ @@ -292,23 +364,11 @@ class CoreExport InspIRCd : public classbase */ time_t OLDTIME; - /** A 64k buffer used to read client lines into + /** 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 - */ - socklen_t length; - - /** Time offset in seconds - * This offset is added to all calls to Time(). Use SetTimeDelta() to update - */ - int time_delta; - #ifdef WIN32 IPC* WindowsIPC; #endif @@ -324,8 +384,10 @@ class CoreExport InspIRCd : public classbase ProcessUserHandler HandleProcessUser; IsNickHandler HandleIsNick; IsIdentHandler HandleIsIdent; - FindDescriptorHandler HandleFindDescriptor; FloodQuitUserHandler HandleFloodQuitUser; + 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. @@ -340,7 +402,7 @@ class CoreExport InspIRCd : public classbase * hash and set its descriptor to FD_MAGIC_NUMBER so the data * falls into the abyss :p */ - User *FakeClient; + FakeUser* FakeClient; /** Returns the next available UID for this server. */ @@ -350,13 +412,13 @@ class CoreExport InspIRCd : public classbase * @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 &); + User* FindUUID(const std::string &); /** 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 char *); + User* FindUUID(const char *); /** Build the ISUPPORT string by triggering all modules On005Numeric events */ @@ -386,10 +448,18 @@ class CoreExport InspIRCd : public classbase */ SocketEngine* SE; + /** Thread engine, Handles threading where required + */ + ThreadEngine* Threads; + + /** The thread/class used to read config files in REHASH and on startup + */ + ConfigReaderThread* ConfigThread; + /** LogManager handles logging. */ LogManager *Logs; - + /** ModuleManager contains everything related to loading/unloading * modules. */ @@ -433,30 +503,24 @@ class CoreExport InspIRCd : public classbase */ chan_hash* chanlist; + /** List of the open ports + */ + std::vector ports; + /** Set to the current signal recieved */ int s_signal; + /** Protocol interface, overridden by server protocol modules + */ + ProtocolInterface* PI; + /** Get the current time * Because this only calls time() once every time around the mainloop, * it is much faster than calling time() directly. - * @param delta True to use the delta as an offset, false otherwise * @return The current time as an epoch value (time_t) */ - time_t Time(bool delta = false); - - /** Set the time offset in seconds - * This offset is added to Time() to offset the system time by the specified - * number of seconds. - * @param delta The number of seconds to offset - * @return The old time delta - */ - int SetTimeDelta(int delta); - - /** Get the time offset in seconds - * @return The current time delta (in seconds) - */ - int GetTimeDelta(); + time_t Time(); /** Process a user whos socket has been flagged as active * @param cu The user to process @@ -466,11 +530,9 @@ class CoreExport InspIRCd : public classbase caller1 ProcessUser; /** 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 @@ -478,7 +540,7 @@ class CoreExport InspIRCd : public classbase * @param addr The address to bind to (IP only) * @return True if the port was bound successfully */ - bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true); + 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 @@ -541,11 +603,6 @@ class CoreExport InspIRCd : public classbase */ 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 */ @@ -558,31 +615,27 @@ class CoreExport InspIRCd : public classbase */ bool OpenLog(char** argv, int argc); - /** Close the currently open log file - */ - void CloseLog(); - /** Return true if a channel name is valid * @param chname A channel name to verify * @return True if the name is valid */ - bool IsChannel(const char *chname); + caller2 IsChannel; /** Return true if str looks like a server ID * @param string to check against */ - bool IsSID(const std::string &str); + caller1 IsSID; /** Rehash the local server */ - void Rehash(); + caller1 Rehash; /** Handles incoming signals after being set * @param signal the signal recieved */ void SignalHandler(int signal); - /** Sets the signal recieved + /** Sets the signal recieved * @param signal the signal recieved */ static void SetSignal(int signal); @@ -614,7 +667,7 @@ class CoreExport InspIRCd : public classbase * @param n A nickname to verify * @return True if the nick is valid */ - caller1 IsNick; + caller2 IsNick; /** Return true if an ident is valid * @param An ident to verify @@ -622,13 +675,6 @@ class CoreExport InspIRCd : public classbase */ 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 @@ -657,19 +703,26 @@ class CoreExport InspIRCd : public classbase * The parameters provided are identical to that sent to the * handler for class cmd_mode. * @param parameters The mode parameters - * @param pcnt The number of items you have given in the first parameter * @param user The user to send error messages to */ - void SendMode(const char **parameters, int pcnt, User *user); + void SendMode(const std::vector& parameters, User *user); + + /** 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. + */ + 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. - * This operates identically to the global function match(), - * except for that it takes std::string arguments rather than - * const char* ones. - * @param sliteral The literal string to match against - * @param spattern The pattern to match against. CIDR and globs are supported. + /** 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. */ - bool MatchText(const std::string &sliteral, const std::string &spattern); + 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 @@ -678,7 +731,7 @@ class CoreExport InspIRCd : public classbase * @param user The user to execute the command as * @return True if the command handler was called successfully */ - CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user); + 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 @@ -748,7 +801,7 @@ class CoreExport InspIRCd : public classbase * @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 char* data,const char* input, const char* hashtype); + 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. @@ -787,23 +840,6 @@ class CoreExport InspIRCd : public classbase */ InspIRCd(int argc, char** argv); - /** Output a log message to the ircd.log file - * The text will only be output if the current loglevel - * is less than or equal to the level you provide - * @param level A log level from the DebugLevel enum - * @param text Format string of to write to the log - * @param ... Format arguments of text to write to the log - */ - void Log(int level, const char* text, ...); - - /** Output a log message to the ircd.log file - * The text will only be output if the current loglevel - * is less than or equal to the level you provide - * @param level A log level from the DebugLevel enum - * @param text Text to write to the log - */ - void Log(int level, 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 @@ -819,7 +855,7 @@ class CoreExport InspIRCd : public classbase * @param format Format string for the numeric * @param ... Parameters for the format string */ - void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...); + 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. @@ -868,10 +904,16 @@ class CoreExport InspIRCd : public classbase */ void BufferedSocketCull(); + /** Adds an extban char to the 005 token. + */ + void AddExtBanChar(char c); + char* GetReadBuffer() { return this->ReadBuffer; } }; +ENTRYPOINT; + #endif