/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2013-2014 Attila Molnar * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell * Copyright (C) 2013 Daniel Vassdal * Copyright (C) 2012 Robby * Copyright (C) 2010 Craig Edwards * Copyright (C) 2010 Adam * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2009 Uli Schlachter * Copyright (C) 2008-2009 Robin Burchell * Copyright (C) 2008 Thomas Stagner * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public * License as published by the Free Software Foundation, version 2. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "inspircd.h" /* * Suggested implementation... * class LogManager * bool AddLogType(const std::string &type, enum loglevel, LogStream *) * bool DelLogType(const std::string &type, LogStream *) * Log(const std::string &type, enum loglevel, const std::string &msg) * std::map > logstreams (holds a 'chain' of logstreams for each type that are all notified when a log happens) * * class LogStream * std::string type * virtual void OnLog(enum loglevel, const std::string &msg) * * How it works: * Modules create their own logstream types (core will create one for 'file logging' for example) and create instances of these logstream types * and register interest in a certain logtype. Globbing is not here, with the exception of * - for all events.. loglevel is used to drop * events that are of no interest to a logstream. * * When Log is called, the vector of logstreams for that type is iterated (along with the special vector for "*"), and all registered logstreams * 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. * 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. * * NOTE: Somehow we have to let LogManager manage the non-blocking file streams and provide an interface to share them with various LogStreams, * as, for example, a user may want to let 'KILL' and 'XLINE' snotices go to /home/ircd/inspircd/logs/operactions.log, or whatever. How * can we accomplish this easily? I guess with a map of pre-loved logpaths, and a pointer of FILE *.. * */ const char LogStream::LogHeader[] = "Log started for " INSPIRCD_VERSION; LogManager::LogManager() : Logging(false) { } LogManager::~LogManager() { } void LogManager::OpenFileLogs() { if (ServerInstance->Config->cmdline.forcedebug) { ServerInstance->Config->RawLog = true; return; } /* Skip rest of logfile opening if we are running -nolog. */ if (!ServerInstance->Config->cmdline.writelog) return; std::map logmap; ConfigTagList tags = ServerInstance->Config->ConfTags("log"); for(ConfigIter i = tags.first; i != tags.second; ++i) { ConfigTag* tag = i->second; std::string method = tag->getString("method"); if (!stdalgo::string::equalsci(method, "file")) { continue; } std::string type = tag->getString("type"); std::string level = tag->getString("level"); LogLevel loglevel = LOG_DEFAULT; if (stdalgo::string::equalsci(level, "rawio")) { loglevel = LOG_RAWIO; ServerInstance->Config->RawLog = true; } else if (stdalgo::string::equalsci(level, "debug")) { loglevel = LOG_DEBUG; } else if (stdalgo::string::equalsci(level, "verbose")) { loglevel = LOG_VERBOSE; } else if (stdalgo::string::equalsci(level, "default")) { loglevel = LOG_DEFAULT; } else if (stdalgo::string::equalsci(level, "sparse")) { loglevel = LOG_SPARSE; } else if (stdalgo::string::equalsci(level, "none")) { loglevel = LOG_NONE; } FileWriter* fw; std::string target = ServerInstance->Config->Paths.PrependLog(tag->getString("target")); std::map::iterator fwi = logmap.find(target); if (fwi == logmap.end()) { char realtarget[256]; time_t time = ServerInstance->Time(); struct tm *mytime = gmtime(&time); strftime(realtarget, sizeof(realtarget), target.c_str(), mytime); FILE* f = fopen(realtarget, "a"); fw = new FileWriter(f, tag->getUInt("flush", 20, 1, UINT_MAX)); logmap.insert(std::make_pair(target, fw)); } else { fw = fwi->second; } FileLogStream* fls = new FileLogStream(loglevel, fw); fls->OnLog(LOG_SPARSE, "HEADER", LogStream::LogHeader); AddLogTypes(type, fls, true); } } void LogManager::CloseLogs() { if (ServerInstance->Config && ServerInstance->Config->cmdline.forcedebug) return; LogStreams.clear(); GlobalLogStreams.clear(); for (std::map::iterator i = AllLogStreams.begin(); i != AllLogStreams.end(); ++i) { delete i->first; } AllLogStreams.clear(); } void LogManager::AddLogTypes(const std::string &types, LogStream* l, bool autoclose) { irc::spacesepstream css(types); std::string tok; std::vector excludes; while (css.GetToken(tok)) { if (tok.empty()) { continue; } if (tok.at(0) == '-') { /* Exclude! */ excludes.push_back(tok.substr(1)); } else { AddLogType(tok, l, autoclose); } } // Handle doing things like: USERINPUT USEROUTPUT -USERINPUT should be the same as saying just USEROUTPUT. // (This is so modules could, for example, inject exclusions for logtypes they can't handle.) for (std::vector::iterator i = excludes.begin(); i != excludes.end(); ++i) { if (*i == "*") { /* -* == Exclude all. Why someone would do this, I dunno. */ DelLogStream(l); return; } DelLogType(*i, l); } // Now if it's registered as a global, add the exclusions there too. std::map >::iterator gi = GlobalLogStreams.find(l); if (gi != GlobalLogStreams.end()) { gi->second.swap(excludes); // Swap with the vector in the hash. } } bool LogManager::AddLogType(const std::string &type, LogStream *l, bool autoclose) { LogStreams[type].push_back(l); if (type == "*") GlobalLogStreams.insert(std::make_pair(l, std::vector())); if (autoclose) AllLogStreams[l]++; return true; } void LogManager::DelLogStream(LogStream* l) { for (std::map >::iterator i = LogStreams.begin(); i != LogStreams.end(); ++i) { while (stdalgo::erase(i->second, l)) { // Keep erasing while it exists } } GlobalLogStreams.erase(l); std::map::iterator ai = AllLogStreams.begin(); if (ai == AllLogStreams.end()) { return; /* Done. */ } delete ai->first; AllLogStreams.erase(ai); } bool LogManager::DelLogType(const std::string &type, LogStream *l) { std::map >::iterator i = LogStreams.find(type); if (type == "*") { GlobalLogStreams.erase(l); } if (i != LogStreams.end()) { if (stdalgo::erase(i->second, l)) { if (i->second.size() == 0) { LogStreams.erase(i); } } else { return false; } } else { return false; } std::map::iterator ai = AllLogStreams.find(l); if (ai == AllLogStreams.end()) { return true; } if ((--ai->second) < 1) { AllLogStreams.erase(ai); delete l; } return true; } void LogManager::Log(const std::string &type, LogLevel loglevel, const char *fmt, ...) { if (Logging) return; std::string buf; VAFORMAT(buf, fmt, fmt); this->Log(type, loglevel, buf); } void LogManager::Log(const std::string &type, LogLevel loglevel, const std::string &msg) { if (Logging) { return; } Logging = true; for (std::map >::iterator gi = GlobalLogStreams.begin(); gi != GlobalLogStreams.end(); ++gi) { if (stdalgo::isin(gi->second, type)) { continue; } gi->first->OnLog(loglevel, type, msg); } std::map >::iterator i = LogStreams.find(type); if (i != LogStreams.end()) { for (std::vector::iterator it = i->second.begin(); it != i->second.end(); ++it) { (*it)->OnLog(loglevel, type, msg); } } Logging = false; } FileWriter::FileWriter(FILE* logfile, unsigned int flushcount) : log(logfile) , flush(flushcount) , writeops(0) { } void FileWriter::WriteLogLine(const std::string &line) { if (log == NULL) return; // 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 // throw CoreException("FileWriter::WriteLogLine called with a closed logfile"); fputs(line.c_str(), log); if (++writeops % flush == 0) { fflush(log); } } FileWriter::~FileWriter() { if (log) { fflush(log); fclose(log); log = NULL; } }