/*
* 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/>.
*/
#include "inspircd.h"
#include "xline.h"
/* $ModDesc: Provides the /SHUN command, which stops a user from executing all except configured commands. */
class Shun : public XLine
{
public:
std::string matchtext;
Shun(time_t s_time, long d, std::string src, std::string re, std::string shunmask)
: XLine(s_time, d, src, re, "SHUN")
{
this->matchtext = shunmask;
}
~Shun()
{
}
bool Matches(User *u)
{
// E: overrides shun
if (u->exempt)
return false;
if (InspIRCd::Match(u->GetFullHost(), matchtext) || InspIRCd::Match(u->GetFullRealHost(), matchtext) || InspIRCd::Match(u->nick+"!"+u->ident+"@"+u->GetIPString(), matchtext))
return true;
return false;
}
bool Matches(const std::string &s)
{
if (matchtext == s)
return true;
return false;
}
void DisplayExpiry()
{
ServerInstance->SNO->WriteToSnoMask('x',"Removing expired shun %s (set by %s %ld seconds ago)",
this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
}
const char* Displayable()
{
return matchtext.c_str();
}
};
/** An XLineFactory specialized to generate shun pointers
*/
class ShunFactory : public XLineFactory
{
public:
ShunFactory() : XLineFactory("SHUN") { }
/** Generate a shun
*/
XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
{
return new Shun(set_time, duration, source, reason, xline_specific_mask);
}
bool AutoApplyToUserList(XLine *x)
{
return false;
}
};
//typedef std::vector<Shun> shunlist;
class CommandShun : public Command
{
public:
CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
{
flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
}
CmdResult Handle(const std::vector<std::string>& parameters, User *user)
{
/* syntax: SHUN nick!user@host time :reason goes here */
/* 'time' is a human-readable timestring, like 2d3h2s. */
std::string target = parameters[0];
User *find = ServerInstance->FindNick(target.c_str());
if (find)
target = std::string("*!*@") + find->GetIPString();
if (parameters.size() == 1)
{
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->WriteServ("NOTICE %s :*** Shun %s not found in list, try /stats H.",user->nick.c_str(),target.c_str());
return CMD_FAILURE;
}
}
else
{
// Adding - XXX todo make this respect <insane> tag perhaps..
long duration;
std::string expr;
if (parameters.size() > 2)
{
duration = ServerInstance->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))
{
if (!duration)
{
ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
user->nick.c_str(), target.c_str(), expr.c_str());
}
else
{
time_t c_requires_crap = duration + ServerInstance->Time();
ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
user->nick.c_str(), target.c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), expr.c_str());
}
}
else
{
delete r;
user->WriteServ("NOTICE %s :*** Shun for %s already exists", user->nick.c_str(), target.c_str());
return CMD_FAILURE;
}
}
return CMD_SUCCESS;
}
RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
{
return ROUTE_LOCALONLY;
}
};
class ModuleShun : public Module
{
CommandShun cmd;
ShunFactory f;
std::set<std::string> ShunEnabledCommands;
bool NotifyOfShun;
bool affectopers;
public:
ModuleShun() : cmd(this)
{
ServerInstance->XLines->RegisterFactory(&f);
ServerInstance->AddCommand(&cmd);
Implementation eventlist[] = { I_OnStats, I_OnPreCommand, I_OnRehash };
ServerInstance->Modules->Attach(eventlist, this, 3);
OnRehash(NULL);
}
virtual ~ModuleShun()
{
ServerInstance->XLines->DelAll("SHUN");
ServerInstance->XLines->UnregisterFactory(&f);
}
void Prioritize()
{
Module* alias = ServerInstance->Modules->Find("m_alias.so");
ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, &alias);
}
virtual ModResult OnStats(char symbol, User* user, string_list& out)
{
if (symbol != 'H')
return MOD_RES_PASSTHRU;
ServerInstance->XLines->InvokeStats("SHUN", 223, user, out);
return MOD_RES_DENY;
}
virtual void OnRehash(User* user)
{
ConfigReader MyConf;
std::string cmds = MyConf.ReadValue("shun", "enabledcommands", 0);
if (cmds.empty())
cmds = "PING PONG QUIT";
ShunEnabledCommands.clear();
std::stringstream dcmds(cmds);
std::string thiscmd;
while (dcmds >> thiscmd)
{
ShunEnabledCommands.insert(thiscmd);
}
NotifyOfShun = MyConf.ReadFlag("shun", "notifyuser", "yes", 0);
affectopers = MyConf.ReadFlag("shun", "affectopers", "no", 0);
}
virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser* user, bool validated, const std::string &original_line)
{
if (validated)
return MOD_RES_PASSTHRU;
if (!ServerInstance->XLines->MatchesLine("SHUN", user))
{
/* Not shunned, don't touch. */
return MOD_RES_PASSTHRU;
}
if (!affectopers && IS_OPER(user))
{
/* Don't do anything if the user is an operator and affectopers isn't set */
return MOD_RES_PASSTHRU;
}
std::set<std::string>::iterator i = ShunEnabledCommands.find(command);
if (i == ShunEnabledCommands.end())
{
if (NotifyOfShun)
user->WriteServ("NOTICE %s :*** Command %s not processed, as you have been blocked from issuing commands (SHUN)", user->nick.c_str(), command.c_str());
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[1].clear();
}
/* if we're here, allow the command. */
return MOD_RES_PASSTHRU;
}
virtual Version GetVersion()
{
return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
}
};
MODULE_INIT(ModuleShun)
