1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 #include "filelogger.h"
19 * Suggested implementation...
21 * bool AddLogType(const std::string &type, enum loglevel, LogStream *)
22 * bool DelLogType(const std::string &type, LogStream *)
23 * Log(const std::string &type, enum loglevel, const std::string &msg)
24 * std::map<std::string, std::vector<LogStream *> > logstreams (holds a 'chain' of logstreams for each type that are all notified when a log happens)
28 * virtual void OnLog(enum loglevel, const std::string &msg)
31 * Modules create their own logstream types (core will create one for 'file logging' for example) and create instances of these logstream types
32 * and register interest in a certain logtype. Globbing is not here, with the exception of * - for all events.. loglevel is used to drop
33 * events that are of no interest to a logstream.
35 * When Log is called, the vector of logstreams for that type is iterated (along with the special vector for "*"), and all registered logstreams
36 * are called back ("OnLog" or whatever) to do whatever they like with the message. In the case of the core, this will write to a file.
37 * In the case of the module I plan to write (m_logtochannel or something), it will log to the channel(s) for that logstream, etc.
39 * NOTE: Somehow we have to let LogManager manage the non-blocking file streams and provide an interface to share them with various LogStreams,
40 * as, for example, a user may want to let 'KILL' and 'XLINE' snotices go to /home/ircd/inspircd/logs/operactions.log, or whatever. How
41 * can we accomplish this easily? I guess with a map of pre-loved logpaths, and a pointer of FILE *..
45 LogManager::LogManager()
51 LogManager::~LogManager()
55 ServerInstance->Logs = this;
57 ServerInstance->Logs = NULL;
61 void LogManager::SetupNoFork()
65 FileWriter* fw = new FileWriter(stdout);
66 noforkstream = new FileLogStream(ServerInstance->Config->forcedebug ? DEBUG : DEFAULT, fw);
70 noforkstream->ChangeLevel(ServerInstance->Config->forcedebug ? DEBUG : DEFAULT);
72 AddLogType("*", noforkstream, false);
75 void LogManager::OpenFileLogs()
77 /* Re-register the nofork stream if necessary. */
78 if (ServerInstance->Config->nofork)
82 /* Skip rest of logfile opening if we are running -nolog. */
83 if (!ServerInstance->Config->writelog)
88 std::map<std::string, FileWriter*> logmap;
89 std::map<std::string, FileWriter*>::iterator i;
90 for (int index = 0;; ++index)
92 ConfigTag* tag = ServerInstance->Config->ConfValue("log", index);
95 std::string method = tag->getString("method");
100 std::string type = tag->getString("type");
101 std::string level = tag->getString("level");
102 int loglevel = DEFAULT;
103 if (level == "debug" || ServerInstance->Config->forcedebug)
106 ServerInstance->Config->debugging = true;
108 else if (level == "verbose")
112 else if (level == "default")
116 else if (level == "sparse")
120 else if (level == "none")
125 std::string target = Conf.ReadValue("log", "target", index);
126 if ((i = logmap.find(target)) == logmap.end())
128 FILE* f = fopen(target.c_str(), "a");
129 fw = new FileWriter(f);
130 logmap.insert(std::make_pair(target, fw));
136 FileLogStream* fls = new FileLogStream(loglevel, fw);
137 AddLogTypes(type, fls, true);
141 void LogManager::CloseLogs()
143 std::map<std::string, std::vector<LogStream*> >().swap(LogStreams); /* Clear it */
144 std::map<LogStream*, std::vector<std::string> >().swap(GlobalLogStreams); /* Clear it */
145 for (std::map<LogStream*, int>::iterator i = AllLogStreams.begin(); i != AllLogStreams.end(); ++i)
149 std::map<LogStream*, int>().swap(AllLogStreams); /* And clear it */
152 void LogManager::AddLogTypes(const std::string &types, LogStream* l, bool autoclose)
154 irc::spacesepstream css(types);
156 std::vector<std::string> excludes;
157 while (css.GetToken(tok))
163 if (tok.at(0) == '-')
166 excludes.push_back(tok.substr(1));
170 AddLogType(tok, l, autoclose);
173 // Handle doing things like: USERINPUT USEROUTPUT -USERINPUT should be the same as saying just USEROUTPUT.
174 // (This is so modules could, for example, inject exclusions for logtypes they can't handle.)
175 for (std::vector<std::string>::iterator i = excludes.begin(); i != excludes.end(); ++i)
179 /* -* == Exclude all. Why someone would do this, I dunno. */
185 // Now if it's registered as a global, add the exclusions there too.
186 std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
187 if (gi != GlobalLogStreams.end())
189 gi->second.swap(excludes); // Swap with the vector in the hash.
193 bool LogManager::AddLogType(const std::string &type, LogStream *l, bool autoclose)
195 std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
197 if (i != LogStreams.end())
199 i->second.push_back(l);
203 std::vector<LogStream *> v;
205 LogStreams[type] = v;
210 GlobalLogStreams.insert(std::make_pair(l, std::vector<std::string>()));
215 std::map<LogStream*, int>::iterator ai = AllLogStreams.find(l);
216 if (ai == AllLogStreams.end())
218 AllLogStreams.insert(std::make_pair(l, 1));
229 void LogManager::DelLogStream(LogStream* l)
231 for (std::map<std::string, std::vector<LogStream*> >::iterator i = LogStreams.begin(); i != LogStreams.end(); ++i)
233 std::vector<LogStream*>::iterator it;
234 while ((it = std::find(i->second.begin(), i->second.end(), l)) != i->second.end())
236 if (it == i->second.end())
241 std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
242 if (gi != GlobalLogStreams.end())
244 GlobalLogStreams.erase(gi);
246 std::map<LogStream*, int>::iterator ai = AllLogStreams.begin();
247 if (ai == AllLogStreams.end())
252 AllLogStreams.erase(ai);
255 bool LogManager::DelLogType(const std::string &type, LogStream *l)
257 std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
260 std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
261 if (gi != GlobalLogStreams.end()) GlobalLogStreams.erase(gi);
264 if (i != LogStreams.end())
266 std::vector<LogStream *>::iterator it = std::find(i->second.begin(), i->second.end(), l);
268 if (it != i->second.end())
271 if (i->second.size() == 0)
286 std::map<LogStream*, int>::iterator ai = AllLogStreams.find(l);
287 if (ai == AllLogStreams.end())
292 if ((--ai->second) < 1)
294 AllLogStreams.erase(ai);
301 void LogManager::Log(const std::string &type, int loglevel, const char *fmt, ...)
309 static char buf[65536];
312 vsnprintf(buf, 65536, fmt, a);
315 this->Log(type, loglevel, std::string(buf));
318 void LogManager::Log(const std::string &type, int loglevel, const std::string &msg)
327 for (std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.begin(); gi != GlobalLogStreams.end(); ++gi)
329 if (std::find(gi->second.begin(), gi->second.end(), type) != gi->second.end())
333 gi->first->OnLog(loglevel, type, msg);
336 std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
338 if (i != LogStreams.end())
340 for (std::vector<LogStream *>::iterator it = i->second.begin(); it != i->second.end(); ++it)
342 (*it)->OnLog(loglevel, type, msg);
350 FileWriter::FileWriter(FILE* logfile)
351 : log(logfile), writeops(0)
355 void FileWriter::HandleEvent(EventType ev, int)
359 void FileWriter::WriteLogLine(const std::string &line)
363 // XXX: For now, just return. Don't throw an exception. It'd be nice to find out if this is happening, but I'm terrified of breaking so close to final release. -- w00t
364 // throw CoreException("FileWriter::WriteLogLine called with a closed logfile");
366 fprintf(log,"%s",line.c_str());
373 void FileWriter::Close()
383 FileWriter::~FileWriter()