X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=cf7201c595d8461b59eb3f402de4303bfdcf29f1;hb=77b0de3fedf130ce0d3b50bb2a2e8d98dcf5d3f4;hp=64489aaf6a84f0a29af555fc7c4af233a089e6fd;hpb=3679c5ebb764521ec940a526af16f61985ae15da;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 64489aaf6..cf7201c59 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -2,12 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -17,6 +14,17 @@ #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 @@ -28,29 +36,25 @@ #include "socketengine.h" #include "command_parse.h" #include "snomasks.h" +#include "cull_list.h" +#include "filelogger.h" -/** Returned by some functions to indicate failure, - * and the exit code of the program if it terminates. +/** + * Used to define the maximum number of parameters a command may have. */ -#define ERROR -1 +#define MAXPARAMETERS 127 -/** Crucial defines +/** Returned by some functions to indicate failure. */ -#define ETIREDGERBILS EAGAIN +#define ERROR -1 -/** Debug levels for use with InspIRCd::Log() +/** Support for librodent - + * see http://www.chatspike.net/index.php?z=64 */ -enum DebugLevel -{ - DEBUG = 10, - VERBOSE = 20, - DEFAULT = 30, - SPARSE = 40, - NONE = 50, -}; +#define ETIREDHAMSTERS EAGAIN /** - * This define is used in place of strcmp when we + * 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. @@ -67,13 +71,107 @@ template inline void DELETE(T* x) /** Template function to convert any input type to std::string */ -template inline std::string ConvToStr(const T &in) +template inline std::string ConvNumeric(const T &in) +{ + if (in == 0) return "0"; + char res[MAXBUF]; + char* out = res; + T quotient = in; + while (quotient) { + *out = "0123456789"[ std::abs( (long)quotient % 10 ) ]; + ++out; + quotient /= 10; + } + if ( in < 0) + *out++ = '-'; + *out = 0; + std::reverse(res,out); + 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; 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 inline long ConvToInt(const T &in) +{ + std::stringstream tmp; + if (!(tmp << in)) return 0; + return atoi(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) +{ + 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; +} + /** This class contains various STATS counters * It is used by the InspIRCd class, which internally * has an instance of it. @@ -115,87 +213,28 @@ class serverstats : public classbase /** Total bytes of data received */ double statsRecv; - /** Number of bound listening ports + /** Cpu usage at last sample */ - unsigned long BoundPortCount; - + 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; +/* Forward declaration - required */ class XLineManager; /** The main class of the irc server. @@ -211,13 +250,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 a string describing the last module error to occur */ char MODERR[MAXBUF]; - + /** Remove a ModuleFactory pointer * @param j Index number of the ModuleFactory to remove */ @@ -228,20 +267,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(); @@ -317,26 +348,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; @@ -355,7 +366,22 @@ class InspIRCd : public classbase int time_delta; public: - /** List of server names we've seen. + + /** InspSocket classes pending deletion after being closed. + * We don't delete these immediately as this may cause a segmentation fault. + */ + std::map SocketCull; + + /** 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. */ servernamelist servernames; @@ -363,6 +389,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; @@ -390,11 +420,11 @@ class InspIRCd : public classbase /** Client list, a hash_map containing all clients, local and remote */ - user_hash clientlist; + user_hash* clientlist; /** Channel list, a hash_map containing all channels */ - chan_hash chanlist; + chan_hash* chanlist; /** Local client list, a vector containing only local clients */ @@ -404,17 +434,13 @@ class InspIRCd : public classbase */ std::vector all_opers; - clonemap local_clones; - - clonemap global_clones; - - /** Whowas container, contains a map of vectors of users tracked by WHOWAS + /** Map of local ip addresses for clone counting */ - irc::whowas::whowas_users whowas; + clonemap local_clones; - /** Whowas container, contains a map of time_t to users tracked by WHOWAS + /** Map of global ip addresses for clone counting */ - irc::whowas::whowas_users_fifo whowas_fifo; + clonemap global_clones; /** DNS class, provides resolver facilities to the core and modules */ @@ -444,6 +470,10 @@ class InspIRCd : public classbase */ time_t next_call; + /** Global cull list, will be processed on next iteration + */ + CullList GlobalCulls; + /** Get the current time * Because this only calls time() once every time around the mainloop, * it is much faster than calling time() directly. @@ -460,10 +490,20 @@ 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 + */ + int ModeCount(const char mode); + /** Get the time offset in seconds * @return The current time delta (in seconds) */ @@ -471,7 +511,8 @@ 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); @@ -494,22 +535,13 @@ 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 client A sockaddr to use as temporary storage - * @param server A sockaddr to use as temporary storage * @param port The port number to bind to * @param addr The address to bind to (IP only) * @return True if the port was bound successfully */ - bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr); + bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true); /** Adds a server name to the list of servers we've seen * @param The servername to add @@ -548,7 +580,7 @@ class InspIRCd : public classbase * @param text The text to send */ void WriteOpers(const std::string &text); - + /** Find a nickname in the nick hash * @param nick The nickname to find * @return A pointer to the user, or NULL if the user does not exist @@ -593,20 +625,9 @@ class InspIRCd : public classbase */ void 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 - */ - 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 + /** Close the currently open log file */ - 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 @@ -622,7 +643,7 @@ class InspIRCd : public classbase /** Send text to all users with a specific set of modes * @param modes The modes to check against, without a +, e.g. 'og' - * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the + * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the * mode characters in the first parameter causes receipt of the message, and * if you specify WM_OR, all the modes must be present. * @param text The text format string to send @@ -641,11 +662,19 @@ class InspIRCd : public classbase */ static void Rehash(int status); - /** 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); + /** 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 */ @@ -684,7 +713,7 @@ class InspIRCd : public classbase /** Send an error notice to all local users, opered and unopered * @param s The error string to send */ - void SendError(const char *s); + void SendError(const std::string &s); /** For use with Module::Prioritize(). * When the return value of this function is returned from @@ -826,38 +855,50 @@ class InspIRCd : public classbase * @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); + userrec* FindDescriptor(int socket); /** 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 - * @return True if the resolver was added - */ - bool AddResolver(Resolver* r); + * @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_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 @@ -866,7 +907,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(), @@ -875,7 +916,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 @@ -884,7 +925,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 @@ -892,7 +933,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 @@ -900,7 +941,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 @@ -908,7 +949,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 @@ -916,7 +957,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 @@ -924,7 +965,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 @@ -932,60 +973,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 + * @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 @@ -1013,7 +1054,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 @@ -1032,6 +1073,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 */ @@ -1097,10 +1143,58 @@ 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 + */ + void FloodQuitUser(userrec* current); + + /** 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(). + */ + void Restart(const std::string &reason); + + /** Prepare the ircd for restart or shutdown. + * This function unloads all modules which can be unloaded, + * closes all open sockets, and closes the logfile. + */ + 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); + /** Begin execution of the server. * NOTE: this function NEVER returns. Internally, * after performing some initialisation routines, @@ -1108,6 +1202,11 @@ 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(); }; #endif