Implement logtype exclusion (ie: '* -USERINPUT -USEROUTPUT' to mean everything except USER{INPUT,OUTPUT}), also pretty up and expand on the documentation in LogManager

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@8959 e03df62e-2008-0410-955e-edbf42e46eb7

3 files changed, 175 insertions, 62 deletions

diff --git a/include/logger.h b/include/logger.h
index 754fa26e8..596f98aee 100644
--- a/include/logger.h
+++ b/include/logger.h
@@ -97,7 +97,7 @@ class CoreExport FileWriter : public EventHandler
  *  can go to a channel as well as a file.
  *
  *  HOW THIS WORKS
- *   LogManager handles all instances of LogStreams, LogStreams (or more likely, derived classes) are instantiated and passed to it.
+ *   LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it.
  */
 
 /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it.
@@ -108,15 +108,17 @@ class CoreExport LogStream : public classbase
 	InspIRCd *ServerInstance;
 	int loglvl;
  public:
-	LogStream(InspIRCd *Instance, int loglevel) : loglvl(loglevel)
+	LogStream(InspIRCd *Instance, int loglevel) : ServerInstance(Instance), loglvl(loglevel)
 	{
-		this->ServerInstance = Instance;
 	}
 
+	/* 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
+	 * in the event that the resource is shared, see for example FileLogStream).
+	 */
 	virtual ~LogStream() { }
 
-	/** XXX document me properly.
-	 * Used for on the fly changing of loglevel.
+	/** Changes the loglevel for this LogStream on-the-fly.
+	 * This is needed for -nofork. But other LogStreams could use it to change loglevels.
 	 */
 	void ChangeLevel(int lvl) { this->loglvl = lvl; }
 
@@ -132,23 +134,50 @@ typedef std::map<FileWriter*, int> FileLogMap;
 class CoreExport LogManager : public classbase
 {
  private:
-	bool Logging;														// true when logging, avoids recursion
-	LogStream* noforkstream;											// LogStream for nofork.
+	/** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop.
+	 */
+	bool Logging;
+
+	/** LogStream for -nofork, logs to STDOUT when it's active.
+	 */
+	LogStream* noforkstream;
+
 	InspIRCd *ServerInstance;
+
+	/** Map of active log types and what LogStreams will receive them.
+	 */
 	std::map<std::string, std::vector<LogStream *> > LogStreams;
-	std::map<LogStream *, int> AllLogStreams;							// holds all logstreams
-	std::vector<LogStream *> GlobalLogStreams;							//holds all logstreams with a type of *
-	FileLogMap FileLogs;												// Holds all file logs, refcounted
+
+	/** Refcount map of all LogStreams managed by LogManager.
+	 * 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.
+	 */
+	std::map<LogStream *, int> AllLogStreams;
+
+	/** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT").
+	 */
+	std::map<LogStream *, std::vector<std::string> > GlobalLogStreams;
+
+	/** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing.
+	 */
+	FileLogMap FileLogs;
+
  public:
+
 	LogManager(InspIRCd *Instance)
 	{
 		ServerInstance = Instance;
 		Logging = false;
 	}
 
+	/** Sets up the logstream for -nofork. Called by InspIRCd::OpenLog() and LogManager::OpenFileLogs().
+	 * First time called it creates the nofork stream and stores it in noforkstream. Each call thereafter just readds it to GlobalLogStreams
+	 * and updates the loglevel.
+	 */
 	void SetupNoFork();
 
-	/** XXX document me properly. */
+	/** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance.
+	 * Used for file-stream sharing for FileLogStreams.
+	 */
 	void AddLoggerRef(FileWriter* fw)
 	{
 		FileLogMap::iterator i = FileLogs.find(fw);
@@ -162,7 +191,8 @@ class CoreExport LogManager : public classbase
 		}
 	}
 
-	/** XXX document me properly. */
+	/** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed.
+	 */
 	void DelLoggerRef(FileWriter* fw)
 	{
 		FileLogMap::iterator i = FileLogs.find(fw);
@@ -174,33 +204,54 @@ class CoreExport LogManager : public classbase
 		}
 	}
 
-	/** XXX document me properly. */
-	void OpenSingleFile(FILE* f, const std::string& type, int loglevel);
-	
-	/** XXX document me properly. */
+	/** Opens all logfiles defined in the configuration file using <log method="file">.
+	 */
 	void OpenFileLogs();
-	
-	/** Gives all logstreams a chance to clear up (in destructors) while it deletes them.
+
+	/** Removes all LogStreams, meaning they have to be readded for logging to continue.
+	 * Only LogStreams that were listed in AllLogStreams are actually closed.
 	 */
 	void CloseLogs();
-	
+
+	/** Adds a single LogStream to multiple logtypes.
+	 * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types.
+	 * It is not a good idea to mix values of autoclose for the same LogStream.
+	 * @param type The type string (from configuration, or whatever) to parse.
+	 * @param l The LogStream to add.
+	 * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
+	 */
+	void AddLogTypes(const std::string &type, LogStream *l, bool autoclose);
+
 	/** Registers a new logstream into the logging core, so it can be called for future events
-	 * XXX document me properly.
+	 * It is not a good idea to mix values of autoclose for the same LogStream.
+	 * @param type The type to add this LogStream to.
+	 * @param l The LogStream to add.
+	 * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
+	 * @return True if the LogStream was added successfully, False otherwise.
 	 */
 	bool AddLogType(const std::string &type, LogStream *l, bool autoclose);
-	
+
 	/** Removes a logstream from the core. After removal, it will not recieve further events.
+	 * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore).
 	 */
 	void DelLogStream(LogStream* l);
-	
-	/** XXX document me properly. */
+
+	/** 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.
+	 * 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).
+	 */
 	bool DelLogType(const std::string &type, LogStream *l);
-	
-	/** Pretty self explanatory.
+
+	/** Logs an event, sending it to all LogStreams registered for the type.
+	 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
+	 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
+	 * @param msg The message to be logged (literal).
 	 */
 	void Log(const std::string &type, int loglevel, const std::string &msg);
-	
-	/** Duh.
+
+	/** Logs an event, sending it to all LogStreams registered for the type.
+	 * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
+	 * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
+	 * @param msg The format of the message to be logged. See your C manual on printf() for details.
 	 */
 	void Log(const std::string &type, int loglevel, const char *fmt, ...);
 };
diff --git a/src/logger.cpp b/src/logger.cpp
index c9171292a..20235a826 100644
--- a/src/logger.cpp
+++ b/src/logger.cpp
@@ -60,15 +60,26 @@ void LogManager::SetupNoFork()
 
 void LogManager::OpenFileLogs()
 {
-	if (ServerInstance->Config->nofork) SetupNoFork(); // Call this to reregister the nofork stream.
-	if (!ServerInstance->Config->writelog) return; // Skip rest of logfile opening if we are running -nolog.
+	/* Re-register the nofork stream if necessary. */
+	if (ServerInstance->Config->nofork)
+	{
+		SetupNoFork();
+	}
+	/* Skip rest of logfile opening if we are running -nolog. */
+	if (!ServerInstance->Config->writelog)
+	{
+		return;
+	}
 	ConfigReader* Conf = new ConfigReader(ServerInstance);
 	std::map<std::string, FileWriter*> logmap;
 	std::map<std::string, FileWriter*>::iterator i;
 	for (int index = 0; index < Conf->Enumerate("log"); ++index)
 	{
 		std::string method = Conf->ReadValue("log", "method", index);
-		if (method != "file") continue;
+		if (method != "file")
+		{
+			continue;
+		}
 		std::string type = Conf->ReadValue("log", "type", index);
 		std::string level = Conf->ReadValue("log", "level", index);
 		int loglevel = DEFAULT;
@@ -106,19 +117,14 @@ void LogManager::OpenFileLogs()
 			fw = i->second;
 		}
 		FileLogStream* fls = new FileLogStream(ServerInstance, loglevel, fw);
-		irc::spacesepstream css(type);
-		std::string tok;
-		while (css.GetToken(tok))
-		{
-			AddLogType(tok, fls, true);
-		}
+		AddLogTypes(type, fls, true);
 	}
 }
 
 void LogManager::CloseLogs()
 {
 	std::map<std::string, std::vector<LogStream*> >().swap(LogStreams); /* Clear it */
-	std::vector<LogStream*>().swap(GlobalLogStreams); /* Clear it */
+	std::map<LogStream*, std::vector<std::string> >().swap(GlobalLogStreams); /* Clear it */
 	for (std::map<LogStream*, int>::iterator i = AllLogStreams.begin(); i != AllLogStreams.end(); ++i)
 	{
 		delete i->first;
@@ -126,12 +132,55 @@ void LogManager::CloseLogs()
 	std::map<LogStream*, int>().swap(AllLogStreams); /* And clear it */
 }
 
+void LogManager::AddLogTypes(const std::string &types, LogStream* l, bool autoclose)
+{
+	irc::spacesepstream css(types);
+	std::string tok;
+	std::vector<std::string> 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<std::string>::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<LogStream *, std::vector<std::string> >::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)
 {
 	std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 
 	if (i != LogStreams.end())
+	{
 		i->second.push_back(l);
+	}
 	else
 	{
 		std::vector<LogStream *> v;
@@ -140,7 +189,9 @@ bool LogManager::AddLogType(const std::string &type, LogStream *l, bool autoclos
 	}
 
 	if (type == "*")
-		GlobalLogStreams.push_back(l);
+	{
+		GlobalLogStreams.insert(std::make_pair(l, std::vector<std::string>()));
+	}
 
 	if (autoclose)
 	{
@@ -165,14 +216,21 @@ void LogManager::DelLogStream(LogStream* l)
 		std::vector<LogStream*>::iterator it;
 		while ((it = std::find(i->second.begin(), i->second.end(), l)) != i->second.end())
 		{
-			if (it == i->second.end()) continue;
+			if (it == i->second.end())
+				continue;
 			i->second.erase(it);
 		}
 	}
-	std::vector<LogStream *>::iterator gi = std::find(GlobalLogStreams.begin(), GlobalLogStreams.end(), l);
-	if (gi != GlobalLogStreams.end()) GlobalLogStreams.erase(gi);
+	std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
+	if (gi != GlobalLogStreams.end())
+	{
+		GlobalLogStreams.erase(gi);
+	}
 	std::map<LogStream*, int>::iterator ai = AllLogStreams.begin();
-	if (ai == AllLogStreams.end()) return; /* Done. */
+	if (ai == AllLogStreams.end())
+	{
+		return; /* Done. */
+	}
 	delete ai->first;
 	AllLogStreams.erase(ai);
 }
@@ -182,7 +240,7 @@ bool LogManager::DelLogType(const std::string &type, LogStream *l)
 	std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 	if (type == "*")
 	{
-		std::vector<LogStream *>::iterator gi = std::find(GlobalLogStreams.begin(), GlobalLogStreams.end(), l);
+		std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.find(l);
 		if (gi != GlobalLogStreams.end()) GlobalLogStreams.erase(gi);
 	}
 
@@ -209,7 +267,10 @@ bool LogManager::DelLogType(const std::string &type, LogStream *l)
 	}
 
 	std::map<LogStream*, int>::iterator ai = AllLogStreams.find(l);
-	if (ai == AllLogStreams.end()) return true;
+	if (ai == AllLogStreams.end())
+	{
+		return true;
+	}
 
 	if ((--ai->second) < 1)
 	{
@@ -223,7 +284,9 @@ bool LogManager::DelLogType(const std::string &type, LogStream *l)
 void LogManager::Log(const std::string &type, int loglevel, const char *fmt, ...)
 {
 	if (Logging)
+	{
 		return;
+	}
 
 	va_list a;
 	static char buf[65536];
@@ -238,28 +301,28 @@ void LogManager::Log(const std::string &type, int loglevel, const char *fmt, ...
 void LogManager::Log(const std::string &type, int loglevel, const std::string &msg)
 {
 	if (Logging)
+	{
 		return;
+	}
 
 	Logging = true;
 
-	std::vector<LogStream *>::iterator gi = GlobalLogStreams.begin();
-
-	while (gi != GlobalLogStreams.end())
+	for (std::map<LogStream *, std::vector<std::string> >::iterator gi = GlobalLogStreams.begin(); gi != GlobalLogStreams.end(); ++gi)
 	{
-		(*gi)->OnLog(loglevel, type, msg);
-		gi++;
+		if (std::find(gi->second.begin(), gi->second.end(), type) != gi->second.end())
+		{
+			continue;
+		}
+		gi->first->OnLog(loglevel, type, msg);
 	}
 
 	std::map<std::string, std::vector<LogStream *> >::iterator i = LogStreams.find(type);
 
 	if (i != LogStreams.end())
 	{
-		std::vector<LogStream *>::iterator it = i->second.begin();
-
-		while (it != i->second.end())
+		for (std::vector<LogStream *>::iterator it = i->second.begin(); it != i->second.end(); ++it)
 		{
 			(*it)->OnLog(loglevel, type, msg);
-			it++;
 		}
 	}
 
@@ -282,18 +345,22 @@ bool FileWriter::Readable()
 {
 	return false;
 }
-    
+
 void FileWriter::HandleEvent(EventType, int)
 {
 	WriteLogLine("");
 	if (log)
+	{
 		ServerInstance->SE->DelFd(this);
+	}
 }
 
 void FileWriter::WriteLogLine(const std::string &line)
 {
 	if (line.length())
+	{
 		buffer.append(line);
+	}
 
 	if (log)
 	{
@@ -331,7 +398,9 @@ void FileWriter::Close()
 		ServerInstance->SE->Blocking(fileno(log));
 
 		if (buffer.size())
+		{
 			fprintf(log,"%s",buffer.c_str());
+		}
 
 #ifndef WINDOWS
 		ServerInstance->SE->DelFd(this);
@@ -348,5 +417,3 @@ FileWriter::~FileWriter()
 {
 	this->Close();
 }
-
-
diff --git a/src/modules/m_chanlog.cpp b/src/modules/m_chanlog.cpp
index 68a349981..2a4535fa5 100644
--- a/src/modules/m_chanlog.cpp
+++ b/src/modules/m_chanlog.cpp
@@ -94,12 +94,7 @@ class ModuleChanLog : public Module
 			}
 			std::string target = Conf->ReadValue("log", "target", index);
 			ChannelLogStream* c = new ChannelLogStream(ServerInstance, loglevel, target);
-			irc::spacesepstream css(type);
-			std::string tok;
-			while (css.GetToken(tok))
-			{
-				ServerInstance->Logs->AddLogType(tok, c, true);
-			}
+			ServerInstance->Logs->AddLogTypes(type, c, true);
 			cls.push_back(c);
 		}
 	}