include/logger.h

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