-#include <algorithm>
-#include <vector>
-#include <string>
-#include <sstream>
-#include "inspircd.h"
-#include "modules.h"
-#include "hashcomp.h"
-#include "configreader.h"
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *
+ * 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/>.
+ */
-/* $ModDesc: Gives the /shun command, which stops a user executing all commands except PING and PONG. */
-/* $ModAuthor: Om */
-/* $ModAuthorMail: om@inspircd.org */
-class Shun
-{
-public:
- std::string banmask;
- std::string set_by;
- time_t set_on;
- long length;
- std::string reason;
-
- Shun() { }
-
- Shun(std::string bm, std::string sb, time_t so, long ln, std::string rs) : banmask(bm), set_by(sb), set_on(so), length(ln), reason(rs) { }
-
- bool operator<(const Shun &ban2) const
- {
- return ((this->set_on + this->length) < (ban2.set_on + ban2.length));
- }
-};
+#include "inspircd.h"
+#include "xline.h"
+#include "modules/shun.h"
+#include "modules/stats.h"
-typedef std::vector<Shun> shunlist;
-class ModuleShunBase
+/** An XLineFactory specialized to generate shun pointers
+ */
+class ShunFactory : public XLineFactory
{
public:
- /* shuns is declared here, as our type is right above. Don't try move it. */
- shunlist shuns;
-
- InspIRCd* Srv;
-
- std::string EncodeShun(const Shun &shun)
- {
- std::ostringstream stream;
- stream << shun.banmask << " " << shun.set_by << " " << shun.set_on << " " << shun.length << " " << shun.reason;
- return stream.str();
- }
+ ShunFactory() : XLineFactory("SHUN") { }
- Shun DecodeShun(const std::string &data)
+ /** Generate a shun
+ */
+ XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask) CXX11_OVERRIDE
{
- Shun res;
- std::istringstream stream(data);
- stream >> res.banmask;
- stream >> res.set_by;
- stream >> res.set_on;
- stream >> res.length;
- res.reason = stream.str();
-
- return res;
+ return new Shun(set_time, duration, source, reason, xline_specific_mask);
}
- void ExpireBans()
+ bool AutoApplyToUserList(XLine* x) CXX11_OVERRIDE
{
- while(shuns.size() && shuns.begin()->length && ((shuns.begin()->set_on + shuns.begin()->length) <= Srv->Time()))
- {
- shunlist::iterator iter = shuns.begin();
-
- Srv->SNO->WriteToSnoMask('X', "*** %ld second shun on '%s' (%s) set by %s %ld seconds ago expired", iter->length, iter->banmask.c_str(), iter->reason.c_str(), iter->set_by.c_str(), Srv->Time() - iter->set_on);
- shuns.erase(iter);
- }
+ return false;
}
};
-class cmd_shun : public Command
-{
- private:
- InspIRCd *Srv;
- ModuleShunBase* base;
+//typedef std::vector<Shun> shunlist;
+class CommandShun : public Command
+{
public:
- cmd_shun(InspIRCd* Me, ModuleShunBase* b)
- : Command(Me, "SHUN", "o", 1), Srv(Me), base(b)
+ CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
{
- this->source = "m_shun.so";
+ flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
}
- CmdResult Handle(const char* const*parameters, int pcnt, User *user)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
/* syntax: SHUN nick!user@host time :reason goes here */
/* 'time' is a human-readable timestring, like 2d3h2s. */
-
- base->ExpireBans();
- if(pcnt == 1)
+ std::string target = parameters[0];
+
+ User *find = ServerInstance->FindNick(target);
+ if ((find) && (find->registered == REG_ALL))
+ target = std::string("*!*@") + find->GetIPString();
+
+ if (parameters.size() == 1)
{
- /* form: SHUN mask removes a SHUN */
- for(shunlist::iterator iter = base->shuns.begin(); iter != base->shuns.end(); iter++)
+ if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", user))
{
- if(parameters[0] == iter->banmask)
- {
- Srv->SNO->WriteToSnoMask('X', "*** %s removed shun '%s', set %ld seconds ago with reason '%s'", user->nick, iter->banmask.c_str(), Srv->Time() - iter->set_on, iter->reason.c_str());
- base->shuns.erase(iter);
- return CMD_SUCCESS;
- }
+ ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s", user->nick.c_str(), parameters[0].c_str());
+ }
+ else if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", user))
+ {
+ ServerInstance->SNO->WriteToSnoMask('x',"%s removed SHUN on %s", user->nick.c_str(), target.c_str());
+ }
+ else
+ {
+ user->WriteNotice("*** Shun " + parameters[0] + " not found in list, try /stats H.");
+ return CMD_FAILURE;
}
-
- user->WriteServ("NOTICE %s :*** The mask %s is not currently shunned, try /stats s", user->nick, parameters[0]);
- return CMD_FAILURE;
}
- else if (pcnt >= 2)
+ else
{
- /* full form to add a shun */
- if(Srv->IsValidMask(parameters[0]))
+ // Adding - XXX todo make this respect <insane> tag perhaps..
+ unsigned long duration;
+ std::string expr;
+ if (parameters.size() > 2)
+ {
+ duration = InspIRCd::Duration(parameters[1]);
+ expr = parameters[2];
+ }
+ else
+ {
+ duration = 0;
+ expr = parameters[1];
+ }
+
+ Shun* r = new Shun(ServerInstance->Time(), duration, user->nick.c_str(), expr.c_str(), target.c_str());
+ if (ServerInstance->XLines->AddLine(r, user))
{
- // parameters[0] = Foamy!*@*
- // parameters[1] = 1h3m2s
- // parameters[2] = Tortoise abuser
- for(shunlist::iterator iter = base->shuns.begin(); iter != base->shuns.end(); iter++)
+ if (!duration)
{
- if (parameters[0] == iter->banmask)
- {
- user->WriteServ("NOTICE %s :*** Shun on %s already exists", user->nick, parameters[0]);
- return CMD_FAILURE;
- }
+ ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
+ user->nick.c_str(), target.c_str(), expr.c_str());
}
-
- long length = Srv->Duration(parameters[1]);
-
- std::string reason = (pcnt > 2) ? parameters[2] : "No reason supplied";
-
- base->shuns.push_back(Shun(parameters[0], user->nick, Srv->Time(), length, reason));
-
- std::sort(base->shuns.begin(), base->shuns.end());
-
- if(length > 0)
- Srv->SNO->WriteToSnoMask('X', "*** %s added %ld second shun on '%s' (%s)", user->nick, length, parameters[0], reason.c_str());
else
- Srv->SNO->WriteToSnoMask('X', "*** %s added permanent shun on '%s' (%s)", user->nick, parameters[0], reason.c_str());
-
- return CMD_SUCCESS;
+ {
+ time_t c_requires_crap = duration + ServerInstance->Time();
+ std::string timestr = InspIRCd::TimeString(c_requires_crap);
+ ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
+ user->nick.c_str(), target.c_str(), timestr.c_str(), expr.c_str());
+ }
}
else
{
- user->WriteServ("NOTICE %s :*** Invalid ban mask (%s)", user->nick, parameters[0]);
+ delete r;
+ user->WriteNotice("*** Shun for " + target + " already exists");
+ return CMD_FAILURE;
}
}
+ return CMD_SUCCESS;
+ }
+
+ RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ if (IS_LOCAL(user))
+ return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
- return CMD_FAILURE;
+ return ROUTE_BROADCAST;
}
};
-class ModuleShun : public Module, public ModuleShunBase
+class ModuleShun : public Module, public Stats::EventListener
{
- cmd_shun* mycommand;
+ CommandShun cmd;
+ ShunFactory f;
+ insp::flat_set<std::string> ShunEnabledCommands;
+ bool NotifyOfShun;
+ bool affectopers;
public:
- ModuleShun(InspIRCd* Me)
- : Module::Module(Me)
+ ModuleShun()
+ : Stats::EventListener(this)
+ , cmd(this)
{
- this->Srv = Me;
- mycommand = new cmd_shun(Srv, this);
- Srv->AddCommand(mycommand);
}
- void Implements(char* List)
+ void init() CXX11_OVERRIDE
{
- List[I_OnPreCommand] = List[I_OnSyncOtherMetaData] = List[I_OnDecodeMetaData] = List[I_OnStats] = 1;
+ ServerInstance->XLines->RegisterFactory(&f);
}
-
- virtual int OnStats(char symbol, User* user, string_list& out)
+
+ ~ModuleShun()
{
- ExpireBans();
-
- if(symbol == 's')
- {
- for(shunlist::iterator iter = shuns.begin(); iter != shuns.end(); iter++)
- {
- std::ostringstream format;
- format << Srv->Config->ServerName << " 223 " << user->nick << " :" << iter->banmask << " " << iter->set_on << " " << iter->length << " " << iter->set_by << " " << iter->reason;
- out.push_back(format.str());
- }
- }
-
- return 0;
+ ServerInstance->XLines->DelAll("SHUN");
+ ServerInstance->XLines->UnregisterFactory(&f);
}
- virtual int OnPreCommand(const std::string &command, const char* const*parameters, int pcnt, User* user, bool validated, const std::string &original_line)
+ void Prioritize() CXX11_OVERRIDE
{
- if((command != "PONG") && (command != "PING"))
- {
- ExpireBans();
-
- for(shunlist::iterator iter = shuns.begin(); iter != shuns.end(); iter++)
- if(Srv->MatchText(user->GetFullHost(), iter->banmask) || Srv->MatchText(user->GetFullRealHost(), iter->banmask))
- return 1;
- }
-
- return 0;
+ Module* alias = ServerInstance->Modules->Find("m_alias.so");
+ ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, alias);
}
- virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable)
+ ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
{
- for(shunlist::iterator iter = shuns.begin(); iter != shuns.end(); iter++)
- {
- proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "shun", EncodeShun(*iter));
- }
+ if (stats.GetSymbol() != 'H')
+ return MOD_RES_PASSTHRU;
+
+ ServerInstance->XLines->InvokeStats("SHUN", 223, stats);
+ return MOD_RES_DENY;
}
- virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- if((target_type == TYPE_OTHER) && (extname == "shun"))
+ ConfigTag* tag = ServerInstance->Config->ConfValue("shun");
+ std::string cmds = tag->getString("enabledcommands");
+ std::transform(cmds.begin(), cmds.end(), cmds.begin(), ::toupper);
+
+ if (cmds.empty())
+ cmds = "PING PONG QUIT";
+
+ ShunEnabledCommands.clear();
+
+ irc::spacesepstream dcmds(cmds);
+ std::string thiscmd;
+
+ while (dcmds.GetToken(thiscmd))
{
- shuns.push_back(DecodeShun(extdata));
- std::sort(shuns.begin(), shuns.end());
+ ShunEnabledCommands.insert(thiscmd);
}
+
+ NotifyOfShun = tag->getBool("notifyuser", true);
+ affectopers = tag->getBool("affectopers", false);
}
- virtual ~ModuleShun()
+ ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
{
+ if (validated)
+ return MOD_RES_PASSTHRU;
+
+ if (!ServerInstance->XLines->MatchesLine("SHUN", user))
+ {
+ /* Not shunned, don't touch. */
+ return MOD_RES_PASSTHRU;
+ }
+
+ if (!affectopers && user->IsOper())
+ {
+ /* Don't do anything if the user is an operator and affectopers isn't set */
+ return MOD_RES_PASSTHRU;
+ }
+
+ if (!ShunEnabledCommands.count(command))
+ {
+ if (NotifyOfShun)
+ user->WriteNotice("*** Command " + command + " not processed, as you have been blocked from issuing commands (SHUN)");
+ return MOD_RES_DENY;
+ }
+
+ if (command == "QUIT")
+ {
+ /* Allow QUIT but dont show any quit message */
+ parameters.clear();
+ }
+ else if ((command == "PART") && (parameters.size() > 1))
+ {
+ /* same for PART */
+ parameters.pop_back();
+ }
+
+ /* if we're here, allow the command. */
+ return MOD_RES_PASSTHRU;
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1,0,0,0,0,API_VERSION);
+ return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
}
};
MODULE_INIT(ModuleShun)
-