X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Flogger.h;h=4914e86a2fe992acd3e90281bbf7609b72b52d3f;hb=fa452641bf37077fcda964d59e404a76e1fb13e5;hp=c4729035cdaa8f08f57db3f148e5aad7844fcf1d;hpb=4965a1d6697565b1a72de31deaccfd93180bd403;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/logger.h b/include/logger.h index c4729035c..4914e86a2 100644 --- a/include/logger.h +++ b/include/logger.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. @@ -29,26 +29,20 @@ class CoreExport FileWriter : 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. */ - FileWriter(InspIRCd* Instance, FILE* logfile); - /** This returns false, logfiles are writeable. - */ - virtual bool Readable(); + FileWriter(FILE* logfile); + /** Handle pending write events. * This will flush any waiting data to disk. * If any data remains after the fprintf call, @@ -56,6 +50,7 @@ class CoreExport FileWriter : public EventHandler * 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 @@ -64,48 +59,116 @@ class CoreExport FileWriter : public EventHandler * 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 ~FileWriter(); }; + + +/* + * New world logging! + * The brief summary: + * Logging used to be a simple affair, a FILE * handled by a nonblocking logging class inheriting from EventHandler, that was inserted + * into the socket engine, and wrote lines. If nofork was on, it was printf()'d. + * + * We decided to horribly overcomplicate matters, and create vastly customisable logging. LogManager and LogStream form the visible basis + * of the new interface. Basically, a LogStream can be inherited to do different things with logging output. We inherit from it once in core + * to create a FileLogStream, that writes to a file, for example. Different LogStreams can hook different types of log messages, and different + * levels of output too, for extreme customisation. Multiple LogStreams can hook the same message/levels of output, meaning that e.g. output + * can go to a channel as well as a file. + * + * HOW THIS WORKS + * LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it. + */ + +/** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it. + */ class CoreExport LogStream : public classbase { protected: - InspIRCd *ServerInstance; int loglvl; public: - LogStream(InspIRCd *Instance, int loglevel) : loglvl(loglevel) + LogStream(int loglevel) : loglvl(loglevel) { - this->ServerInstance = Instance; } + /* A LogStream's destructor should do whatever it needs to close any resources it was using (or indicate that it is no longer using a resource + * in the event that the resource is shared, see for example FileLogStream). + */ virtual ~LogStream() { } - virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) { } + /** Changes the loglevel for this LogStream on-the-fly. + * This is needed for -nofork. But other LogStreams could use it to change loglevels. + */ + void ChangeLevel(int lvl) { this->loglvl = lvl; } + + /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it + * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered) + * and msg is, of course, the actual message to log. + */ + virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0; }; typedef std::map FileLogMap; -class CoreExport LogManager : public classbase +class CoreExport LogManager { private: - bool Logging; // true when logging, avoids recursion - InspIRCd *ServerInstance; + /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop. + */ + bool Logging; + + /** LogStream for -nofork, logs to STDOUT when it's active. + */ + LogStream* noforkstream; + + /** Map of active log types and what LogStreams will receive them. + */ std::map > LogStreams; - std::vector GlobalLogStreams; //holds all logstreams with a type of * - FileLogMap FileLogs; /* Holds all file logs, refcounted */ + + /** Refcount map of all LogStreams managed by LogManager. + * If a logstream is not listed here, it won't be automatically closed by LogManager, even if it's loaded in one of the other lists. + */ + std::map AllLogStreams; + + /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT"). + */ + std::map > GlobalLogStreams; + + /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing. + */ + FileLogMap FileLogs; + public: - LogManager(InspIRCd *Instance) + + LogManager() { - ServerInstance = Instance; + noforkstream = NULL; Logging = false; } + ~LogManager() + { + if (noforkstream) + delete noforkstream; + Logging = true; + } + + /** Sets up the logstream for -nofork. Called by InspIRCd::OpenLog() and LogManager::OpenFileLogs(). + * First time called it creates the nofork stream and stores it in noforkstream. Each call thereafter just readds it to GlobalLogStreams + * and updates the loglevel. + */ + void SetupNoFork(); + + /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance. + * Used for file-stream sharing for FileLogStreams. + */ void AddLoggerRef(FileWriter* fw) { FileLogMap::iterator i = FileLogs.find(fw); @@ -119,6 +182,8 @@ class CoreExport LogManager : public classbase } } + /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed. + */ void DelLoggerRef(FileWriter* fw) { FileLogMap::iterator i = FileLogs.find(fw); @@ -130,13 +195,56 @@ class CoreExport LogManager : public classbase } } - void OpenSingleFile(FILE* f, const std::string& type, int loglevel); + /** Opens all logfiles defined in the configuration file using . + */ void OpenFileLogs(); + + /** Removes all LogStreams, meaning they have to be readded for logging to continue. + * Only LogStreams that were listed in AllLogStreams are actually closed. + */ void CloseLogs(); - bool AddLogType(const std::string &type, LogStream *l); + + /** Adds a single LogStream to multiple logtypes. + * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types. + * It is not a good idea to mix values of autoclose for the same LogStream. + * @param type The type string (from configuration, or whatever) to parse. + * @param l The LogStream to add. + * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open. + */ + void AddLogTypes(const std::string &type, LogStream *l, bool autoclose); + + /** Registers a new logstream into the logging core, so it can be called for future events + * It is not a good idea to mix values of autoclose for the same LogStream. + * @param type The type to add this LogStream to. + * @param l The LogStream to add. + * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open. + * @return True if the LogStream was added successfully, False otherwise. + */ + bool AddLogType(const std::string &type, LogStream *l, bool autoclose); + + /** Removes a logstream from the core. After removal, it will not recieve further events. + * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore). + */ + void DelLogStream(LogStream* l); + + /** Removes a LogStream from a single type. If the LogStream has been registered for "*" it will still receive the type unless you remove it from "*" specifically. + * If the LogStream was added with autoclose set to true, then when the last occurrence of the stream is removed it will automatically be closed (freed). + */ bool DelLogType(const std::string &type, LogStream *l); + + /** Logs an event, sending it to all LogStreams registered for the type. + * @param type Log message type (ex: "USERINPUT", "MODULE", ...) + * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE) + * @param msg The message to be logged (literal). + */ void Log(const std::string &type, int loglevel, const std::string &msg); - void Log(const std::string &type, int loglevel, const char *fmt, ...); + + /** Logs an event, sending it to all LogStreams registered for the type. + * @param type Log message type (ex: "USERINPUT", "MODULE", ...) + * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE) + * @param msg The format of the message to be logged. See your C manual on printf() for details. + */ + void Log(const std::string &type, int loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5); }; #endif