#include <time.h>
#include <string>
#include <sstream>
+#include <list>
#include "inspircd_config.h"
+#include "uid.h"
#include "users.h"
#include "channels.h"
#include "socket.h"
#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 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<typename T> inline void DELETE(T* x)
}
};
-/* Forward declaration -- required */
-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 CoreExport 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<std::pair<std::string, long> > FailedPortList;
/** A list of ip addresses cross referenced against clone counts */
typedef std::map<irc::string, unsigned int> 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;
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
- */
- void EraseFactory(int j);
-
- /** Remove a Module pointer
- * @param j Index number of the Module to remove
+ /** Holds the current UID. Used to generate the next one.
*/
- void EraseModule(int j);
-
- /** 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);
+ char current_uid[UUID_LENGTH];
/** Set up the signal handlers
*/
*/
bool DaemonSeed();
- /** Moves the given module to the last slot in the list
- * @param modulename The module name to relocate
- */
- void MoveToLast(std::string modulename);
-
- /** Moves the given module to the first slot in the list
- * @param modulename The module name to relocate
- */
- void MoveToFirst(std::string modulename);
-
- /** Moves one module to be placed after another in the list
- * @param modulename The module name to relocate
- * @param after The module name to place the module after
- */
- void MoveAfter(std::string modulename, std::string after);
-
- /** Moves one module to be placed before another in the list
- * @param modulename The module name to relocate
- * @param after The module name to place the module before
- */
- void MoveBefore(std::string modulename, std::string before);
-
/** Iterate the list of InspSocket objects, removing ones which have timed out
* @param TIME the current time
*/
void DoSocketTimeouts(time_t TIME);
+ /** Sets up UID subsystem
+ */
+ void InitialiseUID();
+
/** Perform background user events such as PING checks
* @param TIME the current time
*/
*/
bool AllModulesReportReady(userrec* user);
- /** Total number of modules loaded into the ircd, minus one
- */
- int ModCount;
-
/** Logfile pathname specified on the commandline, or empty string
*/
char LogFileName[MAXBUF];
- /** The feature names published by various modules
- */
- featurelist Features;
-
- /** The interface names published by various modules
- */
- interfacelist Interfaces;
-
/** The current time, updated in the mainloop
*/
time_t TIME;
*/
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<InspSocket*,InspSocket*> 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
+ * Reason for it:
+ * kludge alert!
+ * SendMode expects a userrec* to send the numeric replies
+ * back to, so we create it a fake user that isnt in the user
+ * hash and set its descriptor to FD_MAGIC_NUMBER so the data
+ * falls into the abyss :p
+ */
+ 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();
/** Socket engine, handles socket activity events
*/
SocketEngine* SE;
+
+ /** ModuleManager contains everything related to loading/unloading
+ * modules.
+ */
+ ModuleManager* Modules;
/** Stats class, holds miscellaneous stats counters
*/
*/
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;
/** Oper list, a vector containing all local and remote opered users
*/
- std::vector<userrec*> all_opers;
+ std::list<userrec*> all_opers;
/** Map of local ip addresses for clone counting
*/
*/
XLineManager* XLines;
- /** A list of Module* module classes
- * Note that this list is always exactly 255 in size.
- * The actual number of loaded modules is available from GetModuleCount()
- */
- ModuleList modules;
-
- /** A list of ModuleFactory* module factories
- * Note that this list is always exactly 255 in size.
- * The actual number of loaded modules is available from GetModuleCount()
- */
- FactoryList factory;
-
/** The time we next call our ping timeout and reg timeout checks
*/
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,
* @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);
* @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);
-
- /** Get the total number of currently loaded modules
- * @return The number of loaded modules
- */
- int GetModuleCount();
-
- /** Find a module by name, and return a Module* to it.
- * This is preferred over iterating the module lists yourself.
- * @param name The module name to look up
- * @return A pointer to the module, or NULL if the module cannot be found
- */
- Module* FindModule(const std::string &name);
+ caller1<void, userrec*> ProcessUser;
/** Bind all ports specified in the configuration file.
* @param bail True if the function should bail back to the shell on failure
*/
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
*/
chanrec* FindChan(const char* chan);
- /** Called by the constructor to load all modules from the config file.
- */
- void LoadAllModules();
-
/** Check for a 'die' tag in the config file, and abort if found
* @return Depending on the configuration, this function may never return
*/
/** 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);
+ bool OpenLog(char** argv, int argc);
/** Close the currently open log file
*/
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 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.
*/
void SendError(const std::string &s);
- /** For use with Module::Prioritize().
- * When the return value of this function is returned from
- * Module::Prioritize(), this specifies that the module wishes
- * to be ordered exactly BEFORE 'modulename'. For more information
- * please see Module::Prioritize().
- * @param modulename The module your module wants to be before in the call list
- * @returns a priority ID which the core uses to relocate the module in the list
- */
- long PriorityBefore(const std::string &modulename);
-
- /** For use with Module::Prioritize().
- * When the return value of this function is returned from
- * Module::Prioritize(), this specifies that the module wishes
- * to be ordered exactly AFTER 'modulename'. For more information please
- * see Module::Prioritize().
- * @param modulename The module your module wants to be after in the call list
- * @returns a priority ID which the core uses to relocate the module in the list
- */
- long PriorityAfter(const std::string &modulename);
-
- /** Publish a 'feature'.
- * There are two ways for a module to find another module it depends on.
- * Either by name, using InspIRCd::FindModule, or by feature, using this
- * function. A feature is an arbitary string which identifies something this
- * module can do. For example, if your module provides SSL support, but other
- * modules provide SSL support too, all the modules supporting SSL should
- * publish an identical 'SSL' feature. This way, any module requiring use
- * of SSL functions can just look up the 'SSL' feature using FindFeature,
- * then use the module pointer they are given.
- * @param FeatureName The case sensitive feature name to make available
- * @param Mod a pointer to your module class
- * @returns True on success, false if the feature is already published by
- * another module.
- */
- bool PublishFeature(const std::string &FeatureName, Module* Mod);
-
- /** Publish a module to an 'interface'.
- * Modules which implement the same interface (the same way of communicating
- * with other modules) can publish themselves to an interface, using this
- * method. When they do so, they become part of a list of related or
- * compatible modules, and a third module may then query for that list
- * and know that all modules within that list offer the same API.
- * A prime example of this is the hashing modules, which all accept the
- * same types of Request class. Consider this to be similar to PublishFeature,
- * except for that multiple modules may publish the same 'feature'.
- * @param InterfaceName The case sensitive interface name to make available
- * @param Mod a pointer to your module class
- * @returns True on success, false on failure (there are currently no failure
- * cases)
- */
- bool PublishInterface(const std::string &InterfaceName, Module* Mod);
-
- /** Return a pair saying how many other modules are currently using the
- * interfaces provided by module m.
- * @param m The module to count usage for
- * @return A pair, where the first value is the number of uses of the interface,
- * and the second value is the interface name being used.
- */
- std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
-
- /** Mark your module as using an interface.
- * If you mark your module as using an interface, then that interface
- * module may not unload until your module has unloaded first.
- * This can be used to prevent crashes by ensuring code you depend on
- * is always in memory while your module is active.
- * @param InterfaceName The interface to use
- */
- void UseInterface(const std::string &InterfaceName);
-
- /** Mark your module as finished with an interface.
- * If you used UseInterface() above, you should use this method when
- * your module is finished with the interface (usually in its destructor)
- * to allow the modules which implement the given interface to be unloaded.
- * @param InterfaceName The interface you are finished with using.
- */
- void DoneWithInterface(const std::string &InterfaceName);
-
- /** Unpublish a 'feature'.
- * When your module exits, it must call this method for every feature it
- * is providing so that the feature table is cleaned up.
- * @param FeatureName the feature to remove
- */
- bool UnpublishFeature(const std::string &FeatureName);
-
- /** Unpublish your module from an interface
- * When your module exits, it must call this method for every interface
- * it is part of so that the interfaces table is cleaned up. Only when
- * the last item is deleted from an interface does the interface get
- * removed.
- * @param InterfaceName the interface to be removed from
- * @param Mod The module to remove from the interface list
- */
- bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
-
- /** Find a 'feature'.
- * There are two ways for a module to find another module it depends on.
- * Either by name, using InspIRCd::FindModule, or by feature, using the
- * InspIRCd::PublishFeature method. A feature is an arbitary string which
- * identifies something this module can do. For example, if your module
- * provides SSL support, but other modules provide SSL support too, all
- * the modules supporting SSL should publish an identical 'SSL' feature.
- * To find a module capable of providing the feature you want, simply
- * call this method with the feature name you are looking for.
- * @param FeatureName The feature name you wish to obtain the module for
- * @returns A pointer to a valid module class on success, NULL on failure.
- */
- Module* FindFeature(const std::string &FeatureName);
-
- /** Find an 'interface'.
- * An interface is a list of modules which all implement the same API.
- * @param InterfaceName The Interface you wish to obtain the module
- * list of.
- * @return A pointer to a deque of Module*, or NULL if the interface
- * does not exist.
- */
- modulelist* FindInterface(const std::string &InterfaceName);
-
- /** Given a pointer to a Module, return its filename
- * @param m The module pointer to identify
- * @return The module name or an empty string
- */
- const std::string& GetModuleName(Module* m);
-
/** Return true if a nickname is valid
* @param n A nickname to verify
* @return True if the nick is valid
*/
- bool IsNick(const char* n);
+ caller1<bool, const char*> 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<bool, const char*> 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<userrec*, int> FindDescriptor;
/** Add a new mode to this server's mode parser
* @param mh The modehandler to add
*/
void WritePID(const std::string &filename);
- /** Returns text describing the last module error
- * @return The last error message to occur
- */
- char* ModuleError();
-
- /** Load a given module file
- * @param filename The file to load
- * @return True if the module was found and loaded
- */
- bool LoadModule(const char* filename);
-
- /** Unload a given module file
- * @param filename The file to unload
- * @return True if the module was unloaded
- */
- bool UnloadModule(const char* filename);
-
/** This constructor initialises all the subsystems and reads the config file.
* @param argc The argument count passed to main()
* @param argv The argument list passed to main()
*/
InspIRCd(int argc, char** argv);
- /** Do one iteration of the mainloop
- * @param process_module_sockets True if module sockets are to be processed
- * this time around the event loop. The is the default.
- */
- void DoOneIteration(bool process_module_sockets = true);
-
/** 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
* fully registered yet, temporarily zline their IP.
* @param current user to quit
*/
- void FloodQuitUser(userrec* current);
+ caller1<void, userrec*> FloodQuitUser;
/** Restart the server.
* This function will not return. If an error occurs,
/** Begin execution of the server.
* NOTE: this function NEVER returns. Internally,
- * after performing some initialisation routines,
- * it will repeatedly call DoOneIteration in a loop.
+ * it will repeatedly loop.
* @return The return value for this function is undefined.
*/
int Run();
* be culled.
*/
void InspSocketCull();
+
+ char* GetReadBuffer()
+ {
+ return this->ReadBuffer;
+ }
};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff