include/logger.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #ifndef LOGGER_H
  22 #define LOGGER_H
  23
  24 /** Simple wrapper providing periodic flushing to a disk-backed file.
  25  */
  26 class CoreExport FileWriter
  27 {
  28  protected:
  29         /** The log file (fd is inside this somewhere,
  30          * we get it out with fileno())
  31          */
  32         FILE* log;
  33
  34         /** Number of write operations that have occured
  35          */
  36         int writeops;
  37
  38  public:
  39         /** The constructor takes an already opened logfile.
  40          */
  41         FileWriter(FILE* logfile);
  42
  43         /** Write one or more preformatted log lines.
  44          * If the data cannot be written immediately,
  45          * this class will insert itself into the
  46          * SocketEngine, and register a write event,
  47          * and when the write event occurs it will
  48          * attempt again to write the data.
  49          */
  50         void WriteLogLine(const std::string &line);
  51
  52         /** Close the log file and cancel any events.
  53          */
  54         virtual ~FileWriter();
  55 };
  56
  57
  58
  59 /*
  60  * New world logging!
  61  * The brief summary:
  62  *  Logging used to be a simple affair, a FILE * handled by a nonblocking logging class inheriting from EventHandler, that was inserted
  63  *  into the socket engine, and wrote lines. If nofork was on, it was printf()'d.
  64  *
  65  *  We decided to horribly overcomplicate matters, and create vastly customisable logging. LogManager and LogStream form the visible basis
  66  *  of the new interface. Basically, a LogStream can be inherited to do different things with logging output. We inherit from it once in core
  67  *  to create a FileLogStream, that writes to a file, for example. Different LogStreams can hook different types of log messages, and different
  68  *  levels of output too, for extreme customisation. Multiple LogStreams can hook the same message/levels of output, meaning that e.g. output
  69  *  can go to a channel as well as a file.
  70  *
  71  *  HOW THIS WORKS
  72  *   LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it.
  73  */
  74
  75 /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it.
  76  */
  77 class CoreExport LogStream : public classbase
  78 {
  79  protected:
  80         int loglvl;
  81  public:
  82         LogStream(int loglevel) : loglvl(loglevel)
  83         {
  84         }
  85
  86         /* 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
  87          * in the event that the resource is shared, see for example FileLogStream).
  88          */
  89         virtual ~LogStream() { }
  90
  91         /** Changes the loglevel for this LogStream on-the-fly.
  92          * This is needed for -nofork. But other LogStreams could use it to change loglevels.
  93          */
  94         void ChangeLevel(int lvl) { this->loglvl = lvl; }
  95
  96         /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it
  97          * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered)
  98          * and msg is, of course, the actual message to log.
  99          */
 100         virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0;
 101 };
 102
 103 typedef std::map<FileWriter*, int> FileLogMap;
 104
 105 class CoreExport LogManager
 106 {
 107  private:
 108         /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop.
 109          */
 110         bool Logging;
 111
 112         /** Map of active log types and what LogStreams will receive them.
 113          */
 114         std::map<std::string, std::vector<LogStream *> > LogStreams;
 115
 116         /** Refcount map of all LogStreams managed by LogManager.
 117          * 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.
 118          */
 119         std::map<LogStream *, int> AllLogStreams;
 120
 121         /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT").
 122          */
 123         std::map<LogStream *, std::vector<std::string> > GlobalLogStreams;
 124
 125         /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing.
 126          */
 127         FileLogMap FileLogs;
 128
 129  public:
 130
 131         LogManager();
 132         ~LogManager();
 133
 134         /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance.
 135          * Used for file-stream sharing for FileLogStreams.
 136          */
 137         void AddLoggerRef(FileWriter* fw)
 138         {
 139                 FileLogMap::iterator i = FileLogs.find(fw);
 140                 if (i == FileLogs.end())
 141                 {
 142                         FileLogs.insert(std::make_pair(fw, 1));
 143                 }
 144                 else
 145                 {
 146                         ++i->second;
 147                 }
 148         }
 149
 150         /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed.
 151          */
 152         void DelLoggerRef(FileWriter* fw)
 153         {
 154                 FileLogMap::iterator i = FileLogs.find(fw);
 155                 if (i == FileLogs.end()) return; /* Maybe should log this? */
 156                 if (--i->second < 1)
 157                 {
 158                         delete i->first;
 159                         FileLogs.erase(i);
 160                 }
 161         }
 162
 163         /** Opens all logfiles defined in the configuration file using \<log method="file">.
 164          */
 165         void OpenFileLogs();
 166
 167         /** Removes all LogStreams, meaning they have to be readded for logging to continue.
 168          * Only LogStreams that were listed in AllLogStreams are actually closed.
 169          */
 170         void CloseLogs();
 171
 172         /** Adds a single LogStream to multiple logtypes.
 173          * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types.
 174          * It is not a good idea to mix values of autoclose for the same LogStream.
 175          * @param type The type string (from configuration, or whatever) to parse.
 176          * @param l The LogStream to add.
 177          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 178          */
 179         void AddLogTypes(const std::string &type, LogStream *l, bool autoclose);
 180
 181         /** Registers a new logstream into the logging core, so it can be called for future events
 182          * It is not a good idea to mix values of autoclose for the same LogStream.
 183          * @param type The type to add this LogStream to.
 184          * @param l The LogStream to add.
 185          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 186          * @return True if the LogStream was added successfully, False otherwise.
 187          */
 188         bool AddLogType(const std::string &type, LogStream *l, bool autoclose);
 189
 190         /** Removes a logstream from the core. After removal, it will not recieve further events.
 191          * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore).
 192          */
 193         void DelLogStream(LogStream* l);
 194
 195         /** 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.
 196          * 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).
 197          */
 198         bool DelLogType(const std::string &type, LogStream *l);
 199
 200         /** Logs an event, sending it to all LogStreams registered for the type.
 201          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 202          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 203          * @param msg The message to be logged (literal).
 204          */
 205         void Log(const std::string &type, int loglevel, const std::string &msg);
 206
 207         /** Logs an event, sending it to all LogStreams registered for the type.
 208          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 209          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 210          * @param fmt The format of the message to be logged. See your C manual on printf() for details.
 211          */
 212         void Log(const std::string &type, int loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5);
 213 };
 214
 215 #endif