1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __LOGMANAGER_H
15 #define __LOGMANAGER_H
17 /** This class implements a nonblocking writer.
18 * Most people writing an ircd give little thought to their disk
19 * i/o. On a congested system, disk writes can block for long
20 * periods of time (e.g. if the system is busy and/or swapping
21 * a lot). If we just use a blocking fprintf() call, this could
22 * block for undesirable amounts of time (half of a second through
23 * to whole seconds). We DO NOT want this, so we make our logfile
24 * nonblocking and hook it into the SocketEngine.
25 * NB: If the operating system does not support nonblocking file
26 * I/O (linux seems to, as does freebsd) this will default to
29 class CoreExport FileWriter : public EventHandler
32 /** The creator/owner of this object
34 InspIRCd* ServerInstance;
36 /** The log file (fd is inside this somewhere,
37 * we get it out with fileno())
41 /** Buffer of pending log lines to be written
45 /** Number of write operations that have occured
50 /** The constructor takes an already opened logfile.
52 FileWriter(InspIRCd* Instance, FILE* logfile);
54 /** This returns false, logfiles are writeable.
56 virtual bool Readable();
58 /** Handle pending write events.
59 * This will flush any waiting data to disk.
60 * If any data remains after the fprintf call,
61 * another write event is scheduled to write
62 * the rest of the data when possible.
64 virtual void HandleEvent(EventType et, int errornum = 0);
66 /** Write one or more preformatted log lines.
67 * If the data cannot be written immediately,
68 * this class will insert itself into the
69 * SocketEngine, and register a write event,
70 * and when the write event occurs it will
71 * attempt again to write the data.
73 void WriteLogLine(const std::string &line);
75 /** Close the log file and cancel any events.
79 /** Close the log file and cancel any events.
80 * (indirectly call Close()
82 virtual ~FileWriter();
90 * Logging used to be a simple affair, a FILE * handled by a nonblocking logging class inheriting from EventHandler, that was inserted
91 * into the socket engine, and wrote lines. If nofork was on, it was printf()'d.
93 * We decided to horribly overcomplicate matters, and create vastly customisable logging. LogManager and LogStream form the visible basis
94 * of the new interface. Basically, a LogStream can be inherited to do different things with logging output. We inherit from it once in core
95 * to create a FileLogStream, that writes to a file, for example. Different LogStreams can hook different types of log messages, and different
96 * levels of output too, for extreme customisation. Multiple LogStreams can hook the same message/levels of output, meaning that e.g. output
97 * can go to a channel as well as a file.
100 * LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it.
103 /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it.
105 class CoreExport LogStream : public classbase
108 InspIRCd *ServerInstance;
111 LogStream(InspIRCd *Instance, int loglevel) : ServerInstance(Instance), loglvl(loglevel)
115 /* 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
116 * in the event that the resource is shared, see for example FileLogStream).
118 virtual ~LogStream() { }
120 /** Changes the loglevel for this LogStream on-the-fly.
121 * This is needed for -nofork. But other LogStreams could use it to change loglevels.
123 void ChangeLevel(int lvl) { this->loglvl = lvl; }
125 /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it
126 * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered)
127 * and msg is, of course, the actual message to log.
129 virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0;
132 typedef std::map<FileWriter*, int> FileLogMap;
134 class CoreExport LogManager : public classbase
137 /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop.
141 /** LogStream for -nofork, logs to STDOUT when it's active.
143 LogStream* noforkstream;
145 InspIRCd *ServerInstance;
147 /** Map of active log types and what LogStreams will receive them.
149 std::map<std::string, std::vector<LogStream *> > LogStreams;
151 /** Refcount map of all LogStreams managed by LogManager.
152 * 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.
154 std::map<LogStream *, int> AllLogStreams;
156 /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT").
158 std::map<LogStream *, std::vector<std::string> > GlobalLogStreams;
160 /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing.
166 LogManager(InspIRCd *Instance)
168 ServerInstance = Instance;
172 /** Sets up the logstream for -nofork. Called by InspIRCd::OpenLog() and LogManager::OpenFileLogs().
173 * First time called it creates the nofork stream and stores it in noforkstream. Each call thereafter just readds it to GlobalLogStreams
174 * and updates the loglevel.
178 /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance.
179 * Used for file-stream sharing for FileLogStreams.
181 void AddLoggerRef(FileWriter* fw)
183 FileLogMap::iterator i = FileLogs.find(fw);
184 if (i == FileLogs.end())
186 FileLogs.insert(std::make_pair(fw, 1));
194 /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed.
196 void DelLoggerRef(FileWriter* fw)
198 FileLogMap::iterator i = FileLogs.find(fw);
199 if (i == FileLogs.end()) return; /* Maybe should log this? */
207 /** Opens all logfiles defined in the configuration file using <log method="file">.
211 /** Removes all LogStreams, meaning they have to be readded for logging to continue.
212 * Only LogStreams that were listed in AllLogStreams are actually closed.
216 /** Adds a single LogStream to multiple logtypes.
217 * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types.
218 * It is not a good idea to mix values of autoclose for the same LogStream.
219 * @param type The type string (from configuration, or whatever) to parse.
220 * @param l The LogStream to add.
221 * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
223 void AddLogTypes(const std::string &type, LogStream *l, bool autoclose);
225 /** Registers a new logstream into the logging core, so it can be called for future events
226 * It is not a good idea to mix values of autoclose for the same LogStream.
227 * @param type The type to add this LogStream to.
228 * @param l The LogStream to add.
229 * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
230 * @return True if the LogStream was added successfully, False otherwise.
232 bool AddLogType(const std::string &type, LogStream *l, bool autoclose);
234 /** Removes a logstream from the core. After removal, it will not recieve further events.
235 * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore).
237 void DelLogStream(LogStream* l);
239 /** 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.
240 * 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).
242 bool DelLogType(const std::string &type, LogStream *l);
244 /** Logs an event, sending it to all LogStreams registered for the type.
245 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
246 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
247 * @param msg The message to be logged (literal).
249 void Log(const std::string &type, int loglevel, const std::string &msg);
251 /** Logs an event, sending it to all LogStreams registered for the type.
252 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
253 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
254 * @param msg The format of the message to be logged. See your C manual on printf() for details.
256 void Log(const std::string &type, int loglevel, const char *fmt, ...);