X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_permchannels.cpp;h=0f3ac001ddb79e3d78fdae96f42346cf9ca229df;hb=80e81e3b81b779901fd9d67f8ae030ee30c0bcec;hp=e86b3cbf6d171dece2453c8e50e110680ad9c980;hpb=be5e83759fc2fbb00d59efa12857f48739522242;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/src/modules/m_permchannels.cpp b/src/modules/m_permchannels.cpp
index e86b3cbf6..0f3ac001d 100644
--- a/src/modules/m_permchannels.cpp
+++ b/src/modules/m_permchannels.cpp
@@ -1,7 +1,14 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2014 Justin Crawford <Justasic@Gmail.com>
+ *   Copyright (C) 2013-2014, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013-2014, 2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012, 2014 Adam <Adam@anope.org>
+ *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
  *   Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -19,193 +26,147 @@
 
 
 #include "inspircd.h"
+#include "listmode.h"
+#include <fstream>
 
-/* $ModDesc: Provides support for channel mode +P to provide permanent channels */
 
-struct ListModeData
+/** Handles the +P channel mode
+ */
+class PermChannel : public ModeHandler
 {
-	std::string modes;
-	std::string params;
+ public:
+	PermChannel(Module* Creator)
+		: ModeHandler(Creator, "permanent", 'P', PARAM_NONE, MODETYPE_CHANNEL)
+	{
+		oper = true;
+	}
+
+	ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
+	{
+		if (adding == channel->IsModeSet(this))
+			return MODEACTION_DENY;
+
+		channel->SetMode(this, adding);
+		if (!adding)
+			channel->CheckDestroy();
+
+		return MODEACTION_ALLOW;
+	}
 };
 
-// Not in a class due to circular dependancy hell.
+// Not in a class due to circular dependency hell.
 static std::string permchannelsconf;
-static bool WriteDatabase(Module* mod, bool save_listmodes)
+static bool WriteDatabase(PermChannel& permchanmode, Module* mod, bool save_listmodes)
 {
-	FILE *f;
+	/*
+	 * We need to perform an atomic write so as not to fuck things up.
+	 * So, let's write to a temporary file, flush it, then rename the file..
+	 *     -- w00t
+	 */
 
+	// If the user has not specified a configuration file then we don't write one.
 	if (permchannelsconf.empty())
-	{
-		// Fake success.
 		return true;
-	}
-
-	std::string tempname = permchannelsconf + ".tmp";
 
-	/*
-	 * We need to perform an atomic write so as not to fuck things up.
-	 * So, let's write to a temporary file, flush and sync the FD, then rename the file..
-	 *		-- w00t
-	 */
-	f = fopen(tempname.c_str(), "w");
-	if (!f)
+	std::string permchannelsnewconf = permchannelsconf + ".tmp";
+	std::ofstream stream(permchannelsnewconf.c_str());
+	if (!stream.is_open())
 	{
-		ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot create database! %s (%d)", strerror(errno), errno);
-		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot create new db: %s (%d)", strerror(errno), errno);
+		ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Cannot create database \"%s\"! %s (%d)", permchannelsnewconf.c_str(), strerror(errno), errno);
+		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot create new permchan db \"%s\": %s (%d)", permchannelsnewconf.c_str(), strerror(errno), errno);
 		return false;
 	}
 
-	fputs("# Permchannels DB\n# This file is autogenerated; any changes will be overwritten!\n<config format=\"compat\">\n", f);
-	// Now, let's write.
-	std::string line;
-	for (chan_hash::const_iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); i++)
+	stream << "# This file is automatically generated by m_permchannels. Any changes will be overwritten." << std::endl
+		<< "<config format=\"xml\">" << std::endl;
+
+	const chan_hash& chans = ServerInstance->GetChans();
+	for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i)
 	{
 		Channel* chan = i->second;
-		if (!chan->IsModeSet('P'))
+		if (!chan->IsModeSet(permchanmode))
 			continue;
 
 		std::string chanmodes = chan->ChanModes(true);
 		if (save_listmodes)
 		{
-			ListModeData lm;
+			std::string modes;
+			std::string params;
 
-			// Bans are managed by the core, so we have to process them separately
-			lm.modes = std::string(chan->bans.size(), 'b');
-			for (BanList::const_iterator j = chan->bans.begin(); j != chan->bans.end(); ++j)
+			const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
+			for (ModeParser::ListModeList::const_iterator j = listmodes.begin(); j != listmodes.end(); ++j)
 			{
-				lm.params += j->data;
-				lm.params += ' ';
-			}
+				ListModeBase* lm = *j;
+				ListModeBase::ModeList* list = lm->GetList(chan);
+				if (!list || list->empty())
+					continue;
+
+				size_t n = 0;
+				// Append the parameters
+				for (ListModeBase::ModeList::const_iterator k = list->begin(); k != list->end(); ++k, n++)
+				{
+					params += k->mask;
+					params += ' ';
+				}
 
-			// All other listmodes are managed by modules, so we need to ask them (call their
-			// OnSyncChannel() handler) to give our ProtoSendMode() a list of modes that are
-			// set on the channel. The ListModeData struct is passed as an opaque pointer
-			// that will be passed back to us by the module handling the mode.
-			FOREACH_MOD(I_OnSyncChannel, OnSyncChannel(chan, mod, &lm));
+				// Append the mode letters (for example "IIII", "gg")
+				modes.append(n, lm->GetModeChar());
+			}
 
-			if (!lm.modes.empty())
+			if (!params.empty())
 			{
 				// Remove the last space
-				lm.params.erase(lm.params.end()-1);
+				params.erase(params.end()-1);
 
 				// If there is at least a space in chanmodes (that is, a non-listmode has a parameter)
 				// insert the listmode mode letters before the space. Otherwise just append them.
 				std::string::size_type p = chanmodes.find(' ');
 				if (p == std::string::npos)
-					chanmodes += lm.modes;
+					chanmodes += modes;
 				else
-					chanmodes.insert(p, lm.modes);
+					chanmodes.insert(p, modes);
 
 				// Append the listmode parameters (the masks themselves)
 				chanmodes += ' ';
-				chanmodes += lm.params;
+				chanmodes += params;
 			}
 		}
 
-		std::string chants = ConvToStr(chan->age);
-		std::string topicts = ConvToStr(chan->topicset);
-		const char* items[] =
-		{
-			"<permchannels channel=",
-			chan->name.c_str(),
-			" ts=",
-			chants.c_str(),
-			" topic=",
-			chan->topic.c_str(),
-			" topicts=",
-			topicts.c_str(),
-			" topicsetby=",
-			chan->setby.c_str(),
-			" modes=",
-			chanmodes.c_str(),
-			">\n"
-		};
-
-		line.clear();
-		int item = 0, ipos = 0;
-		while (item < 13)
-		{
-			char c = items[item][ipos++];
-			if (c == 0)
-			{
-				// end of this string; hop to next string, insert a quote
-				item++;
-				ipos = 0;
-				c = '"';
-			}
-			else if (c == '\\' || c == '"')
-			{
-				line += '\\';
-			}
-			line += c;
-		}
-
-		// Erase last '"'
-		line.erase(line.end()-1);
-		fputs(line.c_str(), f);
+		stream << "<permchannels channel=\"" << ServerConfig::Escape(chan->name)
+			<< "\" ts=\"" << chan->age
+			<< "\" topic=\"" << ServerConfig::Escape(chan->topic)
+			<< "\" topicts=\"" << chan->topicset
+			<< "\" topicsetby=\"" << ServerConfig::Escape(chan->setby)
+			<< "\" modes=\"" << ServerConfig::Escape(chanmodes)
+			<< "\">" << std::endl;
 	}
 
-	int write_error = 0;
-	write_error = ferror(f);
-	write_error |= fclose(f);
-	if (write_error)
+	if (stream.fail())
 	{
-		ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot write to new database! %s (%d)", strerror(errno), errno);
-		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot write to new db: %s (%d)", strerror(errno), errno);
+		ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Cannot write to new database \"%s\"! %s (%d)", permchannelsnewconf.c_str(), strerror(errno), errno);
+		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot write to new permchan db \"%s\": %s (%d)", permchannelsnewconf.c_str(), strerror(errno), errno);
 		return false;
 	}
+	stream.close();
 
 #ifdef _WIN32
 	remove(permchannelsconf.c_str());
 #endif
-	// Use rename to move temporary to new db - this is guarenteed not to fuck up, even in case of a crash.
-	if (rename(tempname.c_str(), permchannelsconf.c_str()) < 0)
+	// Use rename to move temporary to new db - this is guaranteed not to fuck up, even in case of a crash.
+	if (rename(permchannelsnewconf.c_str(), permchannelsconf.c_str()) < 0)
 	{
-		ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot move new to old database! %s (%d)", strerror(errno), errno);
-		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot replace old with new db: %s (%d)", strerror(errno), errno);
+		ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Cannot replace old database \"%s\" with new database \"%s\"! %s (%d)", permchannelsconf.c_str(), permchannelsnewconf.c_str(), strerror(errno), errno);
+		ServerInstance->SNO->WriteToSnoMask('a', "database: cannot replace old permchan db \"%s\" with new db \"%s\": %s (%d)", permchannelsconf.c_str(), permchannelsnewconf.c_str(), strerror(errno), errno);
 		return false;
 	}
 
 	return true;
 }
 
+class ModulePermanentChannels
+	: public Module
+	, public Timer
 
-
-/** Handles the +P channel mode
- */
-class PermChannel : public ModeHandler
-{
- public:
-	PermChannel(Module* Creator) : ModeHandler(Creator, "permanent", 'P', PARAM_NONE, MODETYPE_CHANNEL) { oper = true; }
-
-	ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
-	{
-		if (adding)
-		{
-			if (!channel->IsModeSet('P'))
-			{
-				channel->SetMode('P',true);
-				return MODEACTION_ALLOW;
-			}
-		}
-		else
-		{
-			if (channel->IsModeSet('P'))
-			{
-				channel->SetMode(this,false);
-				if (channel->GetUserCounter() == 0)
-				{
-					channel->DelUser(ServerInstance->FakeClient);
-				}
-				return MODEACTION_ALLOW;
-			}
-		}
-
-		return MODEACTION_DENY;
-	}
-};
-
-class ModulePermanentChannels : public Module
 {
 	PermChannel p;
 	bool dirty;
@@ -214,50 +175,22 @@ class ModulePermanentChannels : public Module
 public:
 
 	ModulePermanentChannels()
-		: p(this), dirty(false), loaded(false)
-	{
-	}
-
-	void init()
-	{
-		ServerInstance->Modules->AddService(p);
-		Implementation eventlist[] = { I_OnChannelPreDelete, I_OnPostTopicChange, I_OnRawMode, I_OnRehash, I_OnBackgroundTimer };
-		ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
-
-		OnRehash(NULL);
-	}
-
-	CullResult cull()
+		: Timer(0, true)
+		, p(this)
+		, dirty(false)
+		, loaded(false)
 	{
-		/*
-		 * DelMode can't remove the +P mode on empty channels, or it will break
-		 * merging modes with remote servers. Remove the empty channels now as
-		 * we know this is not the case.
-		 */
-		chan_hash::iterator iter = ServerInstance->chanlist->begin();
-		while (iter != ServerInstance->chanlist->end())
-		{
-			Channel* c = iter->second;
-			if (c->GetUserCounter() == 0)
-			{
-				chan_hash::iterator at = iter;
-				iter++;
-				FOREACH_MOD(I_OnChannelDelete, OnChannelDelete(c));
-				ServerInstance->chanlist->erase(at);
-				ServerInstance->GlobalCulls.AddItem(c);
-			}
-			else
-				iter++;
-		}
-		ServerInstance->Modes->DelMode(&p);
-		return Module::cull();
 	}
 
-	virtual void OnRehash(User *user)
+	void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 	{
 		ConfigTag* tag = ServerInstance->Config->ConfValue("permchanneldb");
 		permchannelsconf = tag->getString("filename");
 		save_listmodes = tag->getBool("listmodes");
+		SetInterval(tag->getDuration("saveperiod", 5));
+
+		if (!permchannelsconf.empty())
+			permchannelsconf = ServerInstance->Config->Paths.PrependConfig(permchannelsconf);
 	}
 
 	void LoadDatabase()
@@ -271,12 +204,11 @@ public:
 		{
 			ConfigTag* tag = i->second;
 			std::string channel = tag->getString("channel");
-			std::string topic = tag->getString("topic");
 			std::string modes = tag->getString("modes");
 
-			if ((channel.empty()) || (channel.length() > ServerInstance->Config->Limits.ChanMax))
+			if (!ServerInstance->IsChannel(channel))
 			{
-				ServerInstance->Logs->Log("m_permchannels", DEFAULT, "Ignoring permchannels tag with empty or too long channel name (\"" + channel + "\")");
+				ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring permchannels tag with invalid channel name (\"" + channel + "\")");
 				continue;
 			}
 
@@ -284,19 +216,23 @@ public:
 
 			if (!c)
 			{
-				time_t TS = tag->getInt("ts");
-				c = new Channel(channel, ((TS > 0) ? TS : ServerInstance->Time()));
+				time_t TS = tag->getInt("ts", ServerInstance->Time(), 1);
+				c = new Channel(channel, TS);
 
-				c->SetTopic(NULL, topic, true);
-				c->setby = tag->getString("topicsetby");
-				if (c->setby.empty())
-					c->setby = ServerInstance->Config->ServerName;
-				unsigned int topicset = tag->getInt("topicts");
-				// SetTopic() sets the topic TS to now, if there was no topicts saved then don't overwrite that with a 0
-				if (topicset > 0)
-					c->topicset = topicset;
+				time_t topicset = tag->getInt("topicts", 0);
+				std::string topic = tag->getString("topic");
 
-				ServerInstance->Logs->Log("m_permchannels", DEBUG, "Added %s with topic %s", channel.c_str(), topic.c_str());
+				if ((topicset != 0) || (!topic.empty()))
+				{
+					if (topicset == 0)
+						topicset = ServerInstance->Time();
+					std::string topicsetby = tag->getString("topicsetby");
+					if (topicsetby.empty())
+						topicsetby = ServerInstance->Config->GetServerName();
+					c->SetTopic(ServerInstance->FakeClient, topic, topicset, &topicsetby);
+				}
+
+				ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Added %s with topic %s", channel.c_str(), c->topic.c_str());
 
 				if (modes.empty())
 					continue;
@@ -313,7 +249,7 @@ public:
 					ModeHandler* mode = ServerInstance->Modes->FindMode(*n, MODETYPE_CHANNEL);
 					if (mode)
 					{
-						if (mode->GetNumParams(true))
+						if (mode->NeedsParam(true))
 							list.GetToken(par);
 						else
 							par.clear();
@@ -321,32 +257,37 @@ public:
 						mode->OnModeChange(ServerInstance->FakeClient, ServerInstance->FakeClient, c, par, true);
 					}
 				}
+
+				// We always apply the permchannels mode to permanent channels.
+				par.clear();
+				p.OnModeChange(ServerInstance->FakeClient, ServerInstance->FakeClient, c, par, true);
 			}
 		}
 	}
 
-	virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string &param, bool adding, int pcnt)
+	ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding) CXX11_OVERRIDE
 	{
-		if (chan && (chan->IsModeSet('P') || mode == 'P'))
+		if (chan && (chan->IsModeSet(p) || mh == &p))
 			dirty = true;
 
 		return MOD_RES_PASSTHRU;
 	}
 
-	virtual void OnPostTopicChange(User*, Channel *c, const std::string&)
+	void OnPostTopicChange(User*, Channel *c, const std::string&) CXX11_OVERRIDE
 	{
-		if (c->IsModeSet('P'))
+		if (c->IsModeSet(p))
 			dirty = true;
 	}
 
-	void OnBackgroundTimer(time_t)
+	bool Tick(time_t) CXX11_OVERRIDE
 	{
 		if (dirty)
-			WriteDatabase(this, save_listmodes);
+			WriteDatabase(p, this, save_listmodes);
 		dirty = false;
+		return true;
 	}
 
-	void Prioritize()
+	void Prioritize() CXX11_OVERRIDE
 	{
 		// XXX: Load the DB here because the order in which modules are init()ed at boot is
 		// alphabetical, this means we must wait until all modules have done their init()
@@ -361,7 +302,7 @@ public:
 		// Load only when there are no linked servers - we set the TS of the channels we
 		// create to the current time, this can lead to desync because spanningtree has
 		// no way of knowing what we do
-		ProtoServerList serverlist;
+		ProtocolInterface::ServerList serverlist;
 		ServerInstance->PI->GetServerList(serverlist);
 		if (serverlist.size() < 2)
 		{
@@ -371,38 +312,19 @@ public:
 			}
 			catch (CoreException& e)
 			{
-				ServerInstance->Logs->Log("m_permchannels", DEFAULT, "Error loading permchannels database: " + std::string(e.GetReason()));
+				ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error loading permchannels database: " + std::string(e.GetReason()));
 			}
 		}
 	}
 
-	void ProtoSendMode(void* opaque, TargetTypeFlags type, void* target, const std::vector<std::string>& modes, const std::vector<TranslateType>& translate)
-	{
-		// We never pass an empty modelist but better be sure
-		if (modes.empty())
-			return;
-
-		ListModeData* lm = static_cast<ListModeData*>(opaque);
-
-		// Append the mode letters without the trailing '+' (for example "IIII", "gg")
-		lm->modes.append(modes[0].begin()+1, modes[0].end());
-
-		// Append the parameters
-		for (std::vector<std::string>::const_iterator i = modes.begin()+1; i != modes.end(); ++i)
-		{
-			lm->params += *i;
-			lm->params += ' ';
-		}
-	}
-
-	virtual Version GetVersion()
+	Version GetVersion() CXX11_OVERRIDE
 	{
-		return Version("Provides support for channel mode +P to provide permanent channels",VF_VENDOR);
+		return Version("Adds channel mode P (permanent) which prevents the channel from being deleted when the last user leaves.", VF_VENDOR);
 	}
 
-	virtual ModResult OnChannelPreDelete(Channel *c)
+	ModResult OnChannelPreDelete(Channel *c) CXX11_OVERRIDE
 	{
-		if (c->IsModeSet('P'))
+		if (c->IsModeSet(p))
 			return MOD_RES_DENY;
 
 		return MOD_RES_PASSTHRU;