-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * 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 program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 <http://www.gnu.org/licenses/>.
*/
-#include "inspircd.h"
-/* $ModDesc: Provides support for channel mode +P to provide permanent channels */
+#include "inspircd.h"
+#include "listmode.h"
+#include <fstream>
/** Handles the +P channel mode
class PermChannel : public ModeHandler
{
public:
- PermChannel(InspIRCd* Instance) : ModeHandler(Instance, 'P', 0, 0, false, MODETYPE_CHANNEL, false) { }
+ PermChannel(Module* Creator)
+ : ModeHandler(Creator, "permanent", 'P', PARAM_NONE, MODETYPE_CHANNEL)
+ {
+ oper = true;
+ }
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
{
- if (adding)
+ 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 dependency hell.
+static std::string permchannelsconf;
+static bool WriteDatabase(PermChannel& permchanmode, Module* mod, bool save_listmodes)
+{
+ /*
+ * 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())
+ return true;
+
+ std::string permchannelsnewconf = permchannelsconf + ".tmp";
+ std::ofstream stream(permchannelsnewconf.c_str());
+ if (!stream.is_open())
+ {
+ 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;
+ }
+
+ 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(permchanmode))
+ continue;
+
+ std::string chanmodes = chan->ChanModes(true);
+ if (save_listmodes)
{
- if (!channel->IsModeSet('P'))
+ std::string modes;
+ std::string params;
+
+ const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
+ for (ModeParser::ListModeList::const_iterator j = listmodes.begin(); j != listmodes.end(); ++j)
{
- channel->SetMode('P',true);
- return MODEACTION_ALLOW;
+ 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 += ' ';
+ }
+
+ // Append the mode letters (for example "IIII", "gg")
+ modes.append(n, lm->GetModeChar());
}
- }
- else
- {
- if (channel->IsModeSet('P'))
+
+ if (!params.empty())
{
- channel->SetMode('P',false);
+ // Remove the last space
+ 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 += modes;
+ else
+ chanmodes.insert(p, modes);
- if (channel->GetUserCounter() == 0)
- delete channel;
- return MODEACTION_ALLOW;
+ // Append the listmode parameters (the masks themselves)
+ chanmodes += ' ';
+ chanmodes += params;
}
}
- return MODEACTION_DENY;
+ 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;
}
-};
-class ModulePermanentChannels : public Module
+ if (stream.fail())
+ {
+ 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 guaranteed not to fuck up, even in case of a crash.
+ if (rename(permchannelsnewconf.c_str(), permchannelsconf.c_str()) < 0)
+ {
+ 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
+
{
- PermChannel *p;
+ PermChannel p;
+ bool dirty;
+ bool loaded;
+ bool save_listmodes;
public:
- ModulePermanentChannels(InspIRCd* Me) : Module(Me)
+ ModulePermanentChannels()
+ : Timer(0, true)
+ , p(this)
+ , dirty(false)
+ , loaded(false)
+ {
+ }
+
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- p = new PermChannel(ServerInstance);
- if (!ServerInstance->Modes->AddMode(p))
+ 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()
+ {
+ /*
+ * Process config-defined list of permanent channels.
+ * -- w00t
+ */
+ ConfigTagList permchannels = ServerInstance->Config->ConfTags("permchannels");
+ for (ConfigIter i = permchannels.first; i != permchannels.second; ++i)
{
- delete p;
- throw ModuleException("Could not add new modes!");
+ ConfigTag* tag = i->second;
+ std::string channel = tag->getString("channel");
+ std::string modes = tag->getString("modes");
+
+ if (!ServerInstance->IsChannel(channel))
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Ignoring permchannels tag with invalid channel name (\"" + channel + "\")");
+ continue;
+ }
+
+ Channel *c = ServerInstance->FindChan(channel);
+
+ if (!c)
+ {
+ time_t TS = tag->getInt("ts", ServerInstance->Time(), 1);
+ c = new Channel(channel, TS);
+
+ time_t topicset = tag->getInt("topicts", 0);
+ std::string topic = tag->getString("topic");
+
+ 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;
+
+ irc::spacesepstream list(modes);
+ std::string modeseq;
+ std::string par;
+
+ list.GetToken(modeseq);
+
+ // XXX bleh, should we pass this to the mode parser instead? ugly. --w00t
+ for (std::string::iterator n = modeseq.begin(); n != modeseq.end(); ++n)
+ {
+ ModeHandler* mode = ServerInstance->Modes->FindMode(*n, MODETYPE_CHANNEL);
+ if (mode)
+ {
+ if (mode->NeedsParam(true))
+ list.GetToken(par);
+ else
+ par.clear();
+
+ 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);
+ }
}
- Implementation eventlist[] = { I_OnChannelPreDelete };
- ServerInstance->Modules->Attach(eventlist, this, 1);
}
- virtual ~ModulePermanentChannels()
+ ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding) CXX11_OVERRIDE
+ {
+ if (chan && (chan->IsModeSet(p) || mh == &p))
+ dirty = true;
+
+ return MOD_RES_PASSTHRU;
+ }
+
+ void OnPostTopicChange(User*, Channel *c, const std::string&) CXX11_OVERRIDE
{
- ServerInstance->Modes->DelMode(p);
- delete p;
+ if (c->IsModeSet(p))
+ dirty = true;
+ }
+
+ bool Tick(time_t) CXX11_OVERRIDE
+ {
+ if (dirty)
+ WriteDatabase(p, this, save_listmodes);
+ dirty = false;
+ return true;
+ }
+
+ 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()
+ // to be able to set the modes they provide (e.g.: m_stripcolor is inited after us)
+ // Prioritize() is called after all module initialization is complete, consequently
+ // all modes are available now
+ if (loaded)
+ return;
+
+ loaded = true;
+
+ // 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
+ ProtocolInterface::ServerList serverlist;
+ ServerInstance->PI->GetServerList(serverlist);
+ if (serverlist.size() < 2)
+ {
+ try
+ {
+ LoadDatabase();
+ }
+ catch (CoreException& e)
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error loading permchannels database: " + std::string(e.GetReason()));
+ }
+ }
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1,2,0,0,VF_COMMON|VF_VENDOR,API_VERSION);
+ return Version("Adds channel mode P (permanent) which prevents the channel from being deleted when the last user leaves.", VF_VENDOR);
}
- virtual int OnChannelPreDelete(Channel *c)
+ ModResult OnChannelPreDelete(Channel *c) CXX11_OVERRIDE
{
- if (c->IsModeSet('P'))
- return 1;
+ if (c->IsModeSet(p))
+ return MOD_RES_DENY;
- return 0;
+ return MOD_RES_PASSTHRU;
}
};
projects / user / henk / code / inspircd.git / blobdiff