X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=dbbc0375e732bc8a6be105eb96b446ff28405f93;hb=de97b98a41109a517a8e677bf9b48400038f702d;hp=ee02a32b5188e14853903cbbbcb28b025f83c425;hpb=49369545e34e9d16d53c6c62eb8659a590af62ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index ee02a32b5..dbbc0375e 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -6,7 +6,7 @@ * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see - * the file COPYING for details. + * the file COPYING for details. * * --------------------------------------------------- */ @@ -14,10 +14,22 @@ #ifndef __INSPIRCD_H__ #define __INSPIRCD_H__ +#ifndef WIN32 +#define DllExport +#define CoreExport +#define printf_c printf +#else +#include "inspircd_win32wrapper.h" +/** Windows defines these already */ +#undef DELETE +#undef ERROR +#endif + #include #include #include #include "inspircd_config.h" +#include "uid.h" #include "users.h" #include "channels.h" #include "socket.h" @@ -26,6 +38,13 @@ #include "command_parse.h" #include "snomasks.h" #include "cull_list.h" +#include "filelogger.h" +#include "caller.h" + +/** + * Used to define the maximum number of parameters a command may have. + */ +#define MAXPARAMETERS 127 /** Returned by some functions to indicate failure. */ @@ -36,25 +55,6 @@ */ #define ETIREDHAMSTERS EAGAIN -/** Debug levels for use with InspIRCd::Log() - */ -enum DebugLevel -{ - DEBUG = 10, - VERBOSE = 20, - DEFAULT = 30, - SPARSE = 40, - NONE = 50, -}; - -/** - * This define is used in place of strcmp when we - * want to check if a char* string contains only one - * letter. Pretty fast, its just two compares and an - * addition. - */ -#define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) ) - /** Delete a pointer, and NULL its value */ template inline void DELETE(T* x) @@ -63,7 +63,7 @@ template inline void DELETE(T* x) x = NULL; } -/** Template functions to convert any input type to std::string +/** Template function to convert any input type to std::string */ template inline std::string ConvNumeric(const T &in) { @@ -83,36 +83,50 @@ template inline std::string ConvNumeric(const T &in) return res; } +/** 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 unsigned 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 inline std::string ConvToStr(const T &in) { std::stringstream tmp; @@ -120,6 +134,9 @@ template inline std::string ConvToStr(const T &in) return tmp.str(); } +/** Template function to convert any input type to any other type + * (usually an integer or numeric type) + */ template inline long ConvToInt(const T &in) { std::stringstream tmp; @@ -129,6 +146,9 @@ template inline long ConvToInt(const T &in) /** 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) { @@ -187,95 +207,36 @@ class serverstats : public classbase /** Total bytes of data received */ double statsRecv; - /** Number of bound listening ports - */ - unsigned long BoundPortCount; - /** Cpu usage at last sample */ timeval LastCPU; - /** Time last sample was read */ timeval LastSampled; - /** 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), - BoundPortCount(0) + statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0) { } }; -class InspIRCd; - -/** This class implements a nonblocking log-writer. - * Most people writing an ircd give little thought to their disk - * i/o. On a congested system, disk writes can block for long - * periods of time (e.g. if the system is busy and/or swapping - * a lot). If we just use a blocking fprintf() call, this could - * block for undesirable amounts of time (half of a second through - * to whole seconds). We DO NOT want this, so we make our logfile - * nonblocking and hook it into the SocketEngine. - * NB: If the operating system does not support nonblocking file - * I/O (linux seems to, as does freebsd) this will default to - * blocking behaviour. - */ -class FileLogger : public EventHandler -{ - protected: - /** The creator/owner of this object - */ - InspIRCd* ServerInstance; - /** The log file (fd is inside this somewhere, - * we get it out with fileno()) - */ - FILE* log; - /** Buffer of pending log lines to be written - */ - std::string buffer; - /** Number of write operations that have occured - */ - int writeops; - public: - /** The constructor takes an already opened logfile. - */ - FileLogger(InspIRCd* Instance, FILE* logfile); - /** This returns false, logfiles are writeable. - */ - virtual bool Readable(); - /** Handle pending write events. - * This will flush any waiting data to disk. - * If any data remains after the fprintf call, - * another write event is scheduled to write - * the rest of the data when possible. - */ - virtual void HandleEvent(EventType et, int errornum = 0); - /** Write one or more preformatted log lines. - * If the data cannot be written immediately, - * this class will insert itself into the - * SocketEngine, and register a write event, - * and when the write event occurs it will - * attempt again to write the data. - */ - void WriteLogLine(const std::string &line); - /** Close the log file and cancel any events. - */ - virtual void Close(); - /** Close the log file and cancel any events. - * (indirectly call Close() - */ - virtual ~FileLogger(); -}; - /** A list of failed port bindings, used for informational purposes on startup */ typedef std::vector > FailedPortList; /** A list of ip addresses cross referenced against clone counts */ typedef std::map clonemap; +class InspIRCd; + +DEFINE_HANDLER1(ProcessUserHandler, void, userrec*); +DEFINE_HANDLER1(IsNickHandler, bool, const char*); +DEFINE_HANDLER1(IsIdentHandler, bool, const char*); +DEFINE_HANDLER1(FindDescriptorHandler, userrec*, int); +DEFINE_HANDLER1(FloodQuitUserHandler, void, userrec*); + +/* Forward declaration - required */ class XLineManager; /** The main class of the irc server. @@ -291,9 +252,13 @@ class XLineManager; * program in terms of ram usage (basically, you could create * an obese forkbomb built from recursively spawning irc servers!) */ -class InspIRCd : public classbase +class CoreExport InspIRCd : public classbase { private: + /** Holds the current UID. Used to generate the next one. + */ + char current_uid[UUID_LENGTH]; + /** Holds a string describing the last module error to occur */ char MODERR[MAXBUF]; @@ -308,20 +273,12 @@ class InspIRCd : public classbase */ void EraseModule(int j); - /** Build the ISUPPORT string by triggering all modules On005Numeric events - */ - void BuildISupport(); - /** Move a given module to a specific slot in the list * @param modulename The module name to relocate * @param slot The slot to move the module into */ void MoveTo(std::string modulename,int slot); - /** Display the startup banner - */ - void Start(); - /** Set up the signal handlers */ void SetSignals(); @@ -397,26 +354,6 @@ class InspIRCd : public classbase */ char ReadBuffer[65535]; - /** Number of seconds in a minute - */ - const long duration_m; - - /** Number of seconds in an hour - */ - const long duration_h; - - /** Number of seconds in a day - */ - const long duration_d; - - /** Number of seconds in a week - */ - const long duration_w; - - /** Number of seconds in a year - */ - const long duration_y; - /** Used when connecting clients */ insp_sockaddr client, server; @@ -434,14 +371,60 @@ class InspIRCd : public classbase */ int time_delta; +#ifdef WIN32 + IPC* WindowsIPC; +#endif + public: + /** Global cull list, will be processed on next iteration + */ + CullList GlobalCulls; + + + /**** Functors ****/ + + ProcessUserHandler HandleProcessUser; + IsNickHandler HandleIsNick; + IsIdentHandler HandleIsIdent; + FindDescriptorHandler HandleFindDescriptor; + FloodQuitUserHandler HandleFloodQuitUser; + + /** InspSocket classes pending deletion after being closed. + * We don't delete these immediately as this may cause a segmentation fault. + */ + std::map SocketCull; + + /** 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 + */ + userrec *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 + */ + userrec *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 + */ + userrec *FindUUID(const char *); + + /** Build the ISUPPORT string by triggering all modules On005Numeric events + */ + void BuildISupport(); + /** Number of unregistered users online right now. * (Unregistered means before USER/NICK/dns) */ int unregistered_count; - /** List of server names we've seen. + /** List of server names we've seen. */ servernamelist servernames; @@ -449,6 +432,10 @@ class InspIRCd : public classbase */ time_t startup_time; + /** Config file pathname specified on the commandline or via ./configure + */ + char ConfigFileName[MAXBUF]; + /** Mode handler, handles mode setting and removal */ ModeParser* Modes; @@ -478,6 +465,11 @@ class InspIRCd : public classbase */ user_hash* clientlist; + /** Client list stored by UUID. Contains all clients, and is updated + * automatically by the constructor and destructor of userrec. + */ + user_hash* uuidlist; + /** Channel list, a hash_map containing all channels */ chan_hash* chanlist; @@ -490,8 +482,12 @@ class InspIRCd : public classbase */ std::vector all_opers; + /** Map of local ip addresses for clone counting + */ clonemap local_clones; + /** Map of global ip addresses for clone counting + */ clonemap global_clones; /** DNS class, provides resolver facilities to the core and modules @@ -522,9 +518,9 @@ class InspIRCd : public classbase */ time_t next_call; - /** Global cull list, will be processed on next iteration + /** Set to the current signal recieved */ - CullList GlobalCulls; + int s_signal; /** Get the current time * Because this only calls time() once every time around the mainloop, @@ -542,8 +538,14 @@ class InspIRCd : public classbase */ int SetTimeDelta(int delta); + /** Add a user to the local clone map + * @param user The user to add + */ void AddLocalClone(userrec* user); + /** Add a user to the global clone map + * @param user The user to add + */ void AddGlobalClone(userrec* user); /** Number of users with a certain mode set on them @@ -557,9 +559,10 @@ class InspIRCd : public classbase /** 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 deleted + * @return There is no actual return value, however upon exit, the user 'cu' may have been + * marked for deletion in the global CullList. */ - void ProcessUser(userrec* cu); + caller1 ProcessUser; /** Get the total number of currently loaded modules * @return The number of loaded modules @@ -580,13 +583,6 @@ class InspIRCd : public classbase */ int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports); - /** Returns true if this server has the given port bound to the given address - * @param port The port number - * @param addr The address - * @return True if we have a port listening on this address - */ - bool HasPort(int port, char* addr); - /** 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 @@ -633,18 +629,28 @@ class InspIRCd : public classbase */ void WriteOpers(const std::string &text); - /** Find a nickname in the nick hash + /** 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 */ userrec* FindNick(const std::string &nick); - /** Find a nickname in the nick hash + /** 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 */ userrec* FindNick(const char* nick); + /** Find a user in the nick hash ONLY + */ + userrec* FindNickOnly(const char* nick); + + /** Find a user in the nick hash ONLY + */ + userrec* FindNickOnly(const std::string &nick); + /** 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 @@ -674,25 +680,13 @@ class InspIRCd : public classbase /** 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 */ - void OpenLog(char** argv, int argc); - - void CloseLog(); + bool OpenLog(char** argv, int argc); - /** Convert a user to a pseudoclient, disconnecting the real user - * @param user The user to convert - * @param message The quit message to display when exiting the user - * @return True if the operation succeeded + /** Close the currently open log file */ - bool UserToPseudo(userrec* user, const std::string &message); - - /** Convert a pseudoclient to a real user, discarding the pseudoclient - * @param alive A live client - * @param zombie A pseudoclient - * @param message The message to display when quitting the pseudoclient - * @return True if the operation succeeded - */ - bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message); + void CloseLog(); /** Send a server notice to all local users * @param text The text format string to send @@ -723,15 +717,31 @@ class InspIRCd : public classbase bool IsChannel(const char *chname); /** Rehash the local server - * @param status This value is unused, and required for signal handler functions */ - static void Rehash(int status); + void Rehash(); + + /** Handles incoming signals after being set + * @param signal the signal recieved + */ + void SignalHandler(int signal); + + /** Sets the signal recieved + * @param signal the signal recieved + */ + static void SetSignal(int signal); - /** Causes the server to exit immediately + /** Causes the server to exit after unloading modules and + * closing all open file descriptors. + * * @param The exit code to give to the operating system * (See the ExitStatus enum for valid values) */ - static void Exit(int status); + 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); /** Return a count of users, unknown and known connections * @return The number of users @@ -900,39 +910,39 @@ class InspIRCd : public classbase * @param n A nickname to verify * @return True if the nick is valid */ - bool IsNick(const char* n); + caller1 IsNick; /** Return true if an ident is valid * @param An ident to verify * @return True if the ident is valid */ - bool IsIdent(const char* n); + 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 */ - userrec* FindDescriptor(int socket); + caller1 FindDescriptor; /** Add a new mode to this server's mode parser * @param mh The modehandler to add * @param modechar The mode character this modehandler handles * @return True if the mode handler was added */ - bool AddMode(ModeHandler* mh, const unsigned char modechar); + bool AddMode(ModeHandler* mh, const unsigned char modechar); /** Add a new mode watcher to this server's mode parser * @param mw The modewatcher to add * @return True if the modewatcher was added */ - bool AddModeWatcher(ModeWatcher* mw); + bool AddModeWatcher(ModeWatcher* mw); /** Delete a mode watcher from this server's mode parser * @param mw The modewatcher to delete * @return True if the modewatcher was deleted */ - bool DelModeWatcher(ModeWatcher* mw); + bool DelModeWatcher(ModeWatcher* mw); /** Add a dns Resolver class to this server's active set * @param r The resolver to add @@ -950,13 +960,13 @@ class InspIRCd : public classbase * 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); + bool AddResolver(Resolver* r, bool cached); /** Add a command to this server's command parser * @param f A command_t command handler object to add * @throw ModuleException Will throw ModuleExcption if the command already exists */ - void AddCommand(command_t *f); + void AddCommand(command_t *f); /** Send a modechange. * The parameters provided are identical to that sent to the @@ -965,7 +975,7 @@ class InspIRCd : public classbase * @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, userrec *user); + void SendMode(const char **parameters, int pcnt, userrec *user); /** Match two strings using pattern matching. * This operates identically to the global function match(), @@ -974,7 +984,7 @@ class InspIRCd : public classbase * @param sliteral The literal string to match against * @param spattern The pattern to match against. CIDR and globs are supported. */ - bool MatchText(const std::string &sliteral, const std::string &spattern); + bool MatchText(const std::string &sliteral, const std::string &spattern); /** Call the handler for a given command. * @param commandname The command whos handler you wish to call @@ -983,7 +993,7 @@ class InspIRCd : public classbase * @param user The user to execute the command as * @return True if the command handler was called successfully */ - bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user); + CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user); /** Return true if the command is a module-implemented command and the given parameters are valid for it * @param parameters The mode parameters @@ -991,7 +1001,7 @@ class InspIRCd : public classbase * @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, userrec* user); + bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user); /** Add a gline and apply it * @param duration How long the line should last @@ -999,7 +1009,7 @@ class InspIRCd : public classbase * @param reason The reason for the line * @param hostmask The hostmask to set the line against */ - void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); + void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); /** Add a qline and apply it * @param duration How long the line should last @@ -1007,7 +1017,7 @@ class InspIRCd : public classbase * @param reason The reason for the line * @param nickname The nickmask to set the line against */ - void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname); + void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname); /** Add a zline and apply it * @param duration How long the line should last @@ -1015,7 +1025,7 @@ class InspIRCd : public classbase * @param reason The reason for the line * @param ipaddr The ip-mask to set the line against */ - void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr); + void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr); /** Add a kline and apply it * @param duration How long the line should last @@ -1023,7 +1033,7 @@ class InspIRCd : public classbase * @param reason The reason for the line * @param hostmask The hostmask to set the line against */ - void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); + void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); /** Add an eline * @param duration How long the line should last @@ -1031,60 +1041,60 @@ class InspIRCd : public classbase * @param reason The reason for the line * @param hostmask The hostmask to set the line against */ - void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); + void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask); /** Delete a gline * @param hostmask The gline to delete * @return True if the item was removed */ - bool DelGLine(const std::string &hostmask); + bool DelGLine(const std::string &hostmask); /** Delete a qline * @param nickname The qline to delete * @return True if the item was removed */ - bool DelQLine(const std::string &nickname); + bool DelQLine(const std::string &nickname); /** Delete a zline * @param ipaddr The zline to delete * @return True if the item was removed */ - bool DelZLine(const std::string &ipaddr); + bool DelZLine(const std::string &ipaddr); /** Delete a kline * @param hostmask The kline to delete * @return True if the item was removed */ - bool DelKLine(const std::string &hostmask); + bool DelKLine(const std::string &hostmask); /** Delete an eline * @param hostmask The kline to delete * @return True if the item was removed */ - bool DelELine(const std::string &hostmask); + bool DelELine(const std::string &hostmask); /** 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); + bool IsValidMask(const std::string &mask); /** Rehash the local server */ - void RehashServer(); + 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() */ - chanrec* GetChannelIndex(long index); + chanrec* 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(userrec* User, const std::string &LinePrefix, stringstream &TextStream); + void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream); /** Check if the given nickmask matches too many users, send errors to the given user * @param nick A nickmask to match against @@ -1112,7 +1122,7 @@ class InspIRCd : public classbase * (one year, two weeks, three days, four hours, six minutes and five seconds) * @return The total number of seconds */ - long Duration(const char* str); + long Duration(const std::string &str); /** Attempt to compare an oper password to a string from the config file. * This will be passed to handling modules which will compare the data @@ -1131,6 +1141,11 @@ class InspIRCd : public classbase */ 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 */ @@ -1196,10 +1211,29 @@ class InspIRCd : public classbase */ 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 + * @param numeric Numeric to send + * @param text Text of the numeric + */ void SendWhoisLine(userrec* user, userrec* 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(userrec* user, userrec* dest, int numeric, const char* format, ...); + /** 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. @@ -1225,6 +1259,10 @@ class InspIRCd : public classbase */ void ResetMaxBans(); + /** Return a time_t as a human-readable string. + */ + std::string TimeString(time_t curtime); + /** Begin execution of the server. * NOTE: this function NEVER returns. Internally, * after performing some initialisation routines, @@ -1232,6 +1270,16 @@ class InspIRCd : public classbase * @return The return value for this function is undefined. */ int Run(); + + /** Force all InspSockets to be removed which are due to + * be culled. + */ + void InspSocketCull(); + + char* GetReadBuffer() + { + return this->ReadBuffer; + } }; #endif